CLIPlaybook

How to

Scaffold a doc

Start a source doc with the required frontmatter.

What changes

add guides authors through choosing a resource type and writes a starter document in the selected source folder.

When this helps

  • You are creating a new command, workflow, team-member, lifecycle, or reference doc.
  • You want the correct frontmatter instead of copying an old file.
  • A repo has Playbook docs but a new topic needs a safe starting point.

Run this command

terminal
sumr playbook add# interactive scaffoldsumr playbook add --source docs/standards/backend# target folder

Flags you can use

--source <path>

Write the new file into this folder and skip the destination prompt.

--help, -h

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

Keep in mind

  • Review and replace placeholder text before committing.
  • Run sumr playbook validate after editing the generated source doc.