Start
Quick start
From an installed aki to a board you can read, in five steps.
1. Check the sources
aki doctor
output
✓ gitlab signed in as nat ✓ github signed in as nat
With no configuration, aki uses gitlab.com when glab is installed and github.com when gh is. A source marked ✗ says why: usually a missing glab auth login or gh auth login.
2. Open the board
aki
Two panes: To do, what waits on you, and Waiting, what you cannot move further. The board refreshes every 30 seconds and shows the last known state while the first reading is under way.
3. Read a line
one task
▲ Re-review api!889 Typed errors for the key store @ana +1 130 5d
| Part | Meaning |
|---|---|
▲ ▴ | Hot, warm: the urgency score passed a threshold. |
Re-review | The most pressing reason the task is listed. Yellow: yours to do. Cyan: waits on others. |
api!889 | The repository and the reference. |
@ana | Who is on the other side: the author when you review. |
+1 | One more reason than the one shown. |
130 | The urgency score, in panes ordered by urgency. |
5d | For how long the most pressing reason has been true. |
4. Five keys
| Key | Does |
|---|---|
| ↑ ↓ ← → | Move between tasks and panes. |
| Enter | Open the task in the browser, on the thread when there is one. |
| i | Explain the task: why it is listed and how its score adds up. |
| p | Set it aside until a day, or until it moves. |
| ? | Every key. |
The full list is on Keys.
5. Make it yours
aki config init
This writes ~/.config/aki/config.toml with every setting at its default and a comment on each. Common first changes:
- Add Jira.
- Keep your drafts in a pane of their own.
- Split work and personal into spaces.
- Choose the agent that a opens.
Without the board
aki list --todo aki list --count aki list --json
aki list prints the board once. --count gives one line for a prompt or a status bar; --json is for scripts. See Command line.