Skip to content
kandown
GitHubnpm

Reference

View raw

CLI reference

Every Kandown command, its flags, and the output contract that makes them safe to script.

The output contract

Before the commands, the rule that governs all of them:

stdout carries data only — ids, JSON, tables. Everything decorative (✓ Created…, warnings, errors) goes to stderr. Exit code 0 on success, non-zero on failure.

So $(kandown create …) captures exactly one id, and --json | jq never chokes on a checkmark.

Interactive

CommandDescription
kandownWeb UI + terminal board
kandown initInitialize in the current project
kandown boardTerminal UI only, no browser
kandown settingsTerminal settings editor
kandown doctorDiagnose config, daemon, ports, task frontmatter
kandown helpFull help

Tasks

Non-interactive, agent- and CI-friendly.

CommandDescription
kandown listList tasks
kandown show <id>Print a task file's raw content
kandown create "title"Create a task
kandown move <id> <status>Move to a column, or to archived
kandown assign <id> [name]Assign, or unassign by omitting the name
kandown commit [-m msg]git add tasks/ .kandown/kandown.json + commit
kandown exportJSON or CSV out
kandown importTrello JSON or Markdown in

kandown list

kandown list [-s status] [-a assignee] [-t tag] [-p priority] [--archived] [--json]
FlagEffect
-s, --statusFilter by column
-a, --assigneeFilter by assignee
-t, --tagFilter by tag
-p, --priorityFilter by P1P4
--archivedInclude archived tasks
--jsonEmit JSON instead of a table
kandown list --json | jq '.[] | select(.priority=="P1") | .title'

kandown create

kandown create "title" [-p priority] [-a assignee] [-t tag …] [--to status] [--id custom-id] [--json]
FlagEffect
-p, --priorityP1P4
-a, --assigneeAssignee name
-t, --tagA tag; repeat for several
--toTarget column (defaults to the first)
--idUse a specific id instead of generating one
--jsonPrint the whole task object rather than just the id
ID=$(kandown create "Refactor auth middleware" -p P1 -t backend -t security)

kandown move

kandown move <id> <status>
kandown move t14 archived     # archive

Moving to the terminal column fails, with a non-zero exit code, while any depends_on entry is unresolved. See Tasks § dependencies.

kandown work

Prints the full agent context — rules, project instructions, live board digest and the next actionable task — as Markdown on stdout. Documented in For AI agents.

kandown mcp

Starts the stdio MCP server. See MCP server.

Daemon & maintenance

CommandDescription
kandown daemon statusIs this project's daemon running, and on what port
kandown daemon startStart it
kandown daemon stopStop it
kandown daemon refresh-allRestart outdated daemons on the current CLI version
kandown projectsList every open Kandown project on this machine
kandown updateUpdate the CLI and the project's kandown.html

Tip

kandown doctor is the first thing to run when something is off. It checks config, daemon state, port availability and every task's frontmatter, and tells you how to fix what it finds.

Environment variables

VariableEffect
KANDOWN_NO_UPDATE=1Disable the background update check (recommended in CI)
KANDOWN_DEBUG=1Print full stack traces instead of a one-line summary
KANDOWN_AGENT_HOOK_URLEndpoint that receives tasks from Send to Agent / TUI g
KANDOWN_AGENT_HOOK_LABELCustom label for the agent hook button
KANDOWN_AGENT_HOOK_HEADERSJSON object of extra headers for the hook request

Edit this page on GitHub →