Use the CLI
Read CLI output and identifiers
Choose Markdown or JSON output and keep project, task, Sprint, Milestone, 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.
| Identifier | Used for | Do not substitute |
|---|---|---|
projectId | Project-scoped commands and optional --project | A task number or session number |
taskNumber | task get, task update, task delete, and task comment | A task ID or work-run ID |
sprintNumber | Task --sprint and Task Builder set-sprint --sprint | A Sprint GUID or task number |
milestoneNumber | milestone get, milestone update, task --milestone, and Task Builder set-milestone --milestone | A Milestone GUID or task number |
taskWorkRunId | work-run get and work-run complete | A task number |
sessionNumber | Task Builder sessions and --session | A Plan or draft position |
draftPlanId | Proposed Plan mutations and task membership | A mutable Plan position |
draftId | Draft-task mutations | A mutable draft position |
| Plan position | Proposed Plan display context | A stable proposed Plan ID |
| Draft position | Display and ordering context | A stable draft ID |
Sprint and Milestone numbers are positive and scoped to the selected project. Get a Sprint number from the project's Sprints page and a Milestone number from its Milestones page or milestone list.
Task list and get output include compact current Sprint/Milestone identity and lifecycle when each feature is enabled. Markdown labels the Started state Current; JSON preserves Started. A disabled feature hides its details independently. Complete snapshots are retained history, not current membership. See Milestone assignment and history.
Milestone objectives, 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 and Milestone objectives are required. Milestone updates preserve an omitted objective and reject a supplied blank value. Use a file for multiline or shell-sensitive content. The CLI command reference explains the exact resolution rules.