Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cline/kanban/llms.txt

Use this file to discover all available pages before exploring further.

The kanban task command (also aliased as kanban tasks) lets you create, update, list, and manage tasks on the Kanban board without opening the web UI. All subcommands print JSON to stdout. On error, they print { "ok": false, "error": "..." } and exit with code 1.

​
Synopsis

kanban task <subcommand> [options]
kanban tasks <subcommand> [options]   # alias
Most subcommands require the Kanban server to be running. Start it first with kanban in a separate terminal.

​
task list

List tasks for a workspace. By default, all columns except trash are returned. 
kanban task list [options]
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
​
--column
string
Filter results to a single column. Accepted values: backlog, in_progress, review, trash.
Example — list all active tasks: 
kanban task list
Example — list only in-progress tasks: 
kanban task list --column in_progress
Example output: 
{
  "ok": true,
  "workspacePath": "/home/user/my-project",
  "column": null,
  "tasks": [
    {
      "id": "abc-123",
      "prompt": "Refactor the authentication module",
      "column": "backlog",
      "baseRef": "main",
      "startInPlanMode": false,
      "autoReviewEnabled": false,
      "autoReviewMode": "commit",
      "createdAt": 1710000000000,
      "updatedAt": 1710000000000,
      "session": null
    }
  ],
  "dependencies": [],
  "count": 1
}

​
task create

Create a new task in the backlog column. 
kanban task create --prompt <text> [options]
​
--prompt
string
required
The task prompt text that the agent will work from.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
​
--base-ref
string
The base branch or git ref for the task. Defaults to the workspace’s current branch.
​
--start-in-plan-mode
boolean
Start the agent in plan mode instead of act mode. Pass true or false, or use the flag alone to imply true.
kanban task create --prompt "..." --start-in-plan-mode
kanban task create --prompt "..." --start-in-plan-mode true
​
--auto-review-enabled
boolean
Enable automatic review behavior when the agent finishes. Pass true or false, or use the flag alone to imply true.
​
--auto-review-mode
string
The action to take when auto-review triggers. Accepted values:
  • commit — commit the agent’s changes
  • pr — open a pull request
  • move_to_trash — move the task to trash
Example: 
kanban task create \
  --prompt "Add rate limiting to the API" \
  --base-ref main \
  --auto-review-enabled \
  --auto-review-mode commit
Example output: 
{
  "ok": true,
  "task": {
    "id": "def-456",
    "column": "backlog",
    "workspacePath": "/home/user/my-project",
    "prompt": "Add rate limiting to the API",
    "baseRef": "main",
    "startInPlanMode": false,
    "autoReviewEnabled": true,
    "autoReviewMode": "commit"
  }
}

​
task update

Update an existing task’s fields. At least one field must be specified. 
kanban task update --task-id <id> [options]
​
--task-id
string
required
The ID of the task to update.
​
--prompt
string
Replacement prompt text for the task.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
​
--base-ref
string
Replacement base branch or git ref.
​
--start-in-plan-mode
boolean
Update the plan mode setting. Pass true, false, or use the flag alone to imply true.
​
--auto-review-enabled
boolean
Update the auto-review enabled setting.
​
--auto-review-mode
string
Update the auto-review mode. Accepted values: commit, pr, move_to_trash.
Example: 
kanban task update --task-id def-456 --prompt "Add rate limiting with Redis"

​
task start

Start a task session and move the task to in_progress. Creates a git worktree if one does not already exist, then launches the agent. 
kanban task start --task-id <id> [options]
​
--task-id
string
required
The ID of the task to start. The task must be in backlog or in_progress.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
Example: 
kanban task start --task-id def-456
Example output: 
{
  "ok": true,
  "task": {
    "id": "def-456",
    "prompt": "Add rate limiting to the API",
    "column": "in_progress",
    "workspacePath": "/home/user/my-project"
  }
}

​
task trash

Move a task (or every task in a column) to trash and clean up its worktree. Stops the active session first. If any linked tasks become unblocked as a result, they are auto-started. Exactly one of --task-id or --column is required. 
kanban task trash [--task-id <id> | --column <column>] [options]
​
--task-id
string
The ID of a single task to move to trash.
​
--column
string
Bulk-trash every task in a column. Accepted values: backlog, in_progress, review, trash.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
Example — trash a single task: 
kanban task trash --task-id def-456
Example — trash all tasks in review: 
kanban task trash --column review
Trashing a task stops its agent session and deletes its git worktree. This cannot be undone from the CLI; you can restore trashed tasks from the web UI.

​
task delete

Permanently delete a task or every task in a column. Unlike task trash, this removes the task immediately with no recovery path. Exactly one of --task-id or --column is required. 
kanban task delete [--task-id <id> | --column <column>] [options]
​
--task-id
string
The ID of a single task to permanently delete.
​
--column
string
Bulk-delete every task in a column. Accepted values: backlog, in_progress, review, trash.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
Example: 
kanban task delete --task-id def-456
Permanent deletion cannot be undone. The task is removed from the board and its worktree is deleted immediately.
Link two tasks so one waits on the other before it is eligible to start. 
kanban task link --task-id <id> --linked-task-id <id> [options]
​
--task-id
string
required
One of the two task IDs to link.
​
--linked-task-id
string
required
The other task ID to link.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
Dependency direction When both tasks are in backlog, Kanban preserves the order you pass: --task-id waits on --linked-task-id. Once only one linked task remains in backlog, Kanban reorients the link so the backlog task is the waiting dependent and the other is the prerequisite. When the prerequisite finishes review and moves to trash, the waiting task becomes ready to start. Example: 
# task-b will not start until task-a finishes
kanban task link --task-id task-b --linked-task-id task-a
Example output: 
{
  "ok": true,
  "workspacePath": "/home/user/my-project",
  "dependency": {
    "id": "dep-789",
    "backlogTaskId": "task-b",
    "backlogTaskColumn": "backlog",
    "linkedTaskId": "task-a",
    "linkedTaskColumn": "backlog",
    "createdAt": 1710000000000
  }
}
Remove an existing dependency link between two tasks. 
kanban task unlink --dependency-id <id> [options]
​
--dependency-id
string
required
The ID of the dependency to remove. You can find dependency IDs in the output of kanban task list or kanban task link.
​
--project-path
string
Path to the workspace. Defaults to the current working directory.
Example: 
kanban task unlink --dependency-id dep-789

​
Error output

When a task command fails, it prints a JSON error to stdout and exits with code 1: 
{
  "ok": false,
  "error": "Task \"def-456\" was not found in workspace /home/user/my-project."
}

Build docs developers (and LLMs) love

Get started for freeTalk to us