Skip to main content

Use the CLI

Read CLI output and identifiers

Choose Markdown or JSON output and keep project, task, work-run, session, and draft identifiers distinct.

Default output is Markdown or concise status text for direct reading. Commands that support --json return structured output for reliable parsing. A nonzero exit means the operation did not succeed.

Keep identifiers distinct

IdentifierUsed forDo not substitute
projectIdProject-scoped commands and optional --projectA task number or session number
taskNumbertask get, task update, task delete, and task commentA task ID or work-run ID
taskWorkRunIdwork-run get and work-run completeA task number
sessionNumberTask Builder sessions and --sessionA Plan or draft position
draftPlanIdProposed Plan mutations and task membershipA mutable Plan position
draftIdDraft-task mutationsA mutable draft position
Plan positionProposed Plan display contextA stable proposed Plan ID
Draft positionDisplay and ordering contextA stable draft ID

Use file input for Markdown

Task comments, work-run summaries and hand-offs, proposed Plan content, and draft-task content accept inline Markdown or a file, but not both forms for the same value. Plan Markdown is optional; task Markdown is required. Use a file for multiline or shell-sensitive content. The CLI command reference explains the exact resolution rules.