Commands
Global flags
| Flag | Description |
|---|---|
--json | Machine-readable JSON output |
--md | Markdown output (where supported) |
--base-url <url> | Override BlocPad API base URL |
--token <token> | Override auth token (discouraged; prefer auth login) |
--project <id> | Override active project for this command |
--task <id> | Override active task for this command |
--task-number <n> | Select task by task_number (example: 123 or ERS-1) |
--version, -v | Print CLI version |
--help, -h | Show help for any command |
Environment variable equivalents
BLOCPAD_OUTPUT=json(same as--json)BLOCPAD_OUTPUT=md(same as--md)BLOCPAD_TOKEN=...
Command groups
Authentication & setup
| Command | Description |
|---|---|
auth login | Log in with a personal access token (PAT) |
auth logout | Remove stored credentials |
auth status | Show current auth state and user info |
auth token create | Create a new personal access token |
Context (active project & task)
| Command | Description |
|---|---|
context show | Display active project, task, and PM mode |
context set-project | Set the active project by ID |
context set-task | Set the active task by ID or task_number |
context clear-task | Unset the active task (keep project) |
context select | Interactive picker for project and task |
context export | Export full context (task + comments + pages + linked tasks) |
Projects
| Command | Description |
|---|---|
projects list | List all projects (includes pm_mode and estimation_mode) |
projects show | Show details for a single project |
Tasks (works in both TM and PM modes)
| Command | Description |
|---|---|
task <NUMBER_OR_ID> | Quick context export for a task (includes pages + linked tasks) |
tasks list | List all tasks in the active project |
tasks show | Show a single task with full details |
tasks create | Create a new task (direct API call) |
tasks comments | List comments on a task |
tasks breadcrumb | Show the parent chain from root to a task |
tasks tree | Show the subtask tree rooted at a task |
tasks next | Pick the next leaf subtask to work on |
tasks focus | Export full context for the next leaf subtask (AI workflow) |
Pages / Wiki
| Command | Description |
|---|---|
pages list | List pages in the active project |
pages show | Show a single page with content |
Traditional PM (requires pm_mode='traditional')
| Command | Description |
|---|---|
goals list | List all goals in the project |
goals show | Show a goal with its child epics and linked pages |
epics list | List epics (optionally filter by --goal <id>) |
epics show | Show an epic with its child stories and linked pages |
stories list | List stories (filter by --epic <id> and/or --sprint <id>) |
stories show | Show a story with child tasks, sprint info, and linked pages |
sprints list | List all sprints with story/task counts |
sprints show | Show a sprint with its stories and tasks |
pm tree | Display full hierarchy: Goals > Epics > Stories > Tasks + Sprints |
Proposals (propose-review-apply workflow)
| Command | Description |
|---|---|
propose task ... | Queue a task mutation (status, comment, create, delete, etc.) |
propose goal ... | Queue a goal mutation (create, update, delete) |
propose epic ... | Queue an epic mutation (create, update, delete) |
propose story ... | Queue a story mutation (create, update, status, delete) |
propose sprint ... | Queue a sprint mutation (create, start, close, add/remove items) |
proposals list | List all pending proposals |
proposals show | Show details of a specific proposal |
proposals discard | Discard a proposal (or --all to clear queue) |
apply | Preview and apply pending proposals to the server |
apply --dry-run | Preview what would be applied without executing |
apply --yes | Apply without interactive confirmation (for CI/AI tools) |