How to

Print the authoring contract

Open the source-doc contract, section, or example.

What changes

authoring prints the source-doc rules that Playbook validates: structure, frontmatter, reference docs, extraction examples, and topic examples.

When this helps

An author needs the exact frontmatter and structure rules.
A reviewer wants to check one section of the Playbook contract.
An AI assistant needs the authoring contract as structured output.

Run this command

terminal

$sumr playbook authoring# full contract$sumr playbook authoring --section frontmatter# one section$sumr playbook authoring --example overview# one example

Flags you can use

--section <id>

Print one contract section instead of the full document. Valid ids come from the CLI output.

--example <id>

Print one authoring example, such as an overview or reference file pattern.

--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.