How to

Sync AI Channel output

Write managed files for each configured AI Channel.

What changes

sync reads Playbook source docs, formats them for each enabled AI Channel, and writes generated files for tools such as Codex, Claude, Cursor, Copilot, Gemini, and OpenCode.

When this helps

You changed Playbook source docs and need generated AI resources updated.
You want to preview AI Channel output before committing generated files.
A channel-specific generated file is stale after a doc change.

Run this command

terminal

$sumr playbook sync --dry-run# preview output$sumr playbook sync --check# check drift in CI$sumr playbook sync --source docs --channel codex# write Codex$sumr playbook sync --json# automation output

Flags you can use

--source <path>

Read one source folder containing Playbook Markdown. Repeat the flag for multiple source folders.

--channel <id>

Write only one AI Channel. Supported ids are claude, codex, cursor, copilot, gemini, and opencode.

--dry-run

Preview writes and warnings without changing files.

--check

Compare generated output without writing files. Exits with a nonzero status when files need to be added, updated, or removed.

--json

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

--verbose

Print detailed sources, warnings, and generated output paths.

--help, -h

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

Keep in mind

Edit source docs first. Generated AI Channel files are outputs, not the place to author durable guidance.
Use --dry-run to preview drift while returning success when managed output differs. Use --check when drift should return a nonzero status in CI.
Do not combine --dry-run and --check.
Invalid configuration stops sync without changing generated files; JSON output reports INVALID_CONFIG for sync and CONFIG_SCHEMA_INVALID for validate.