GuidesWrite Playbook docs

Guides

Enable channels, then verify

Enable the AI Channels a Project needs, validate source Topics, preview changes, then check for drift or write generated files.

AI Channel config

Enable outputs in sumr.yaml.

The source folder stays stable. The channel flags decide which generated files are written for the current Project.

sumr.yamlyaml
playbook:
  sources:
    - docs
  channels:
    codex: true
    claude: true
    cursor: true
    copilot: false

One Resource can serve several AI Channels without maintaining parallel vendor-specific copies.

Before sync

Validate, preview, then check or write.

Validation checks renderable Topics before generated files change. Invalid configuration stops sync: JSON output reports INVALID_CONFIG for sync andCONFIG_SCHEMA_INVALID for validate. A dry run previews each AI Channel's changes. The --check flag compares generated output without writing and returns a nonzero status when it finds drift.

Need the command details? Open validate source docs or sync generated files.

terminal
sumr playbook validate --source docs# check source docssumr playbook sync --source docs --dry-run# preview generated AI Channel filessumr playbook sync --source docs --check# check drift in CIsumr playbook sync --source docs# write generated files

Guide map

Choose the decision you are making.