CLIPlaybook

How to

Check current state

See config, source folders, channels, and topic counts.

What changes

status is the quick repo health check for Playbook. It shows whether config exists, which channels are enabled, which source folders exist, and how many topics are loaded.

When this helps

  • You need to confirm a repo is configured before syncing.
  • Source paths changed and you want to verify Playbook sees them.
  • An AI assistant needs a read-only snapshot of Playbook setup.

Run this command

terminal
sumr playbook status# human summarysumr playbook status --json# structured status

Flags you can use

--json

Return a structured JSON envelope for scripts, CI jobs, and AI assistants.

--help, -h

Show the command syntax, supported flags, and examples without changing files.