Reference

Command line

Every command. aki alone opens the board in a terminal, and prints the list when piped.

Commands

Command	Does
`aki`	The live board in a terminal; the list when piped.
`aki watch`	The live board.
`aki list`	Print the board once. See below.
`aki agent REF`	Open your agent on a task. `--dry-run` only says where, and prints the brief.
`aki spaces`	Your spaces: how each is made, what it holds.
`aki spaces reset`	Start them over from your sources; the old file is kept as `spaces.toml.bak`.
`aki mcp`	Serve the board to an assistant.
`aki mcp setup`	What to paste where to plug it in.
`aki rules`	Every rule and weight as configured.
`aki doctor`	Check the connection to every source.
`aki sounds [NAME]`	List the sounds that can be named, or play one.
`aki cache path`, `clear`	Where the cache is; empty it.
`aki config path`, `init`	Where the configuration is; write one with the defaults.
`aki help`, `version`

aki list

aki list --todo --space Work --filter "repo:web -is:draft" --sort waiting

Option	Meaning
`--todo`, `--waiting`	Only one side.
`--space NAME`	Only what belongs to one of your spaces.
`--filter QUERY`	A filter.
`--sort ORDER`	`urgency` (default), `rule`, `waiting`, `updated`, `created`.
`--reverse`	The opposite order.
`--fresh`	Ask the sources even if a recent reading is cached.
`--json`	Machine-readable.
`--count`	One line.

In a prompt or a status bar

aki list --count

output

11 to do · 13 waiting · 3 set aside · 19 drafts apart

A reading younger than cache_seconds (60 by default) is reused, so the command returns at once when called often.

JSON

aki list --json --todo

one task, shortened

{
  "id": "gitlab:acme/api!889",
  "source": "gitlab",
  "container": "acme/api",
  "reference": "!889",
  "title": "Typed errors for the key store",
  "url": "https://gitlab.example/acme/api/-/merge_requests/889",
  "role": "reviewer",
  "counterpart": "ana",
  "bucket": "todo",
  "waiting_since": 1794000000,
  "urgency": { "score": 130, "rule": 80, "waiting": 15, "ticket": 35, "heat": "hot" },
  "draft": false,
  "tickets": [{ "key": "PROJ-440", "priority": "high" }],
  "reasons": [
    { "kind": "re_review", "bucket": "todo", "priority": 20,
      "why": "the author replied, new commits" }
  ]
}

The document has todo and waiting lists, the sources that answered, and the failures of those that did not. Times are seconds since 1970.

Exit status

Status	Meaning
`0`	Done. `aki list` succeeds as long as something could be shown, even from the cache.
`1`	`aki list`: no source could be read and nothing was remembered. `aki doctor`: a source failed.
`2`	A command or the configuration could not be understood.

PreviousSources NextFAQ