braid scaffold

Scaffold local, GitHub-importable pack content in the current directory. This command is local-only: it writes files, creates or updates braid-pack.json, and does not call the braid API.

Usage

braid scaffold [options]

Supported types

braid scaffold can create:

skill -> skills/<name>/SKILL.md
rule -> rules/<name>.md
agent -> agents/<name>.md
hook -> hooks/<name>.json
workflow -> workflows/<name>.json

Every scaffold run also creates or updates braid-pack.json.

Options

Option	Description
`--type <type>`	Artifact type: `skill`, `rule`, `agent`, `hook`, or `workflow`
`--name <slug>`	Artifact name
`--title <title>`	Artifact title
`--description <description>`	Artifact description
`--linked-skills <list>`	Comma-separated linked skill names for agents
`--skill-ref <name>`	Workflow skill reference
`--agent-ref <name>`	Workflow agent reference
`--workflow-ref <name>`	Workflow sub-flow reference
`--force`	Overwrite an existing target file
`-y, --yes`	Skip prompts when enough flags are provided

Interactive behavior

If you omit required values, braid scaffold prompts for them. In --yes mode, the command stays non-interactive, so you must provide enough flags for the selected type.

Workflow and agent references are validated against the existing manifest. That means referenced skills, agents, and workflows need to already exist in braid-pack.json.

Examples

Start the interactive scaffold flow:

braid scaffold

Create a skill:

braid scaffold --type skill --name requesting-code-review --description "When the user wants a detailed code review"

Create a hook:

braid scaffold --type hook --name pre-tool-guard --title "Pre Tool Guard"

Create an agent linked to existing skills:

braid scaffold --type agent --name code-reviewer --linked-skills requesting-code-review,verification-before-completion

Create a workflow that references an existing skill and agent:

braid scaffold --type workflow --name pr-review --skill-ref requesting-code-review --agent-ref code-reviewer

Repo requirements

braid scaffold works in:

a plain directory with no existing braid pack content
an existing manifest-backed pack repo

It fails instead of mutating the directory when it finds legacy or unmanifested pack content, such as a root SKILL.md without braid-pack.json.