Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Housekeeping and troubleshooting

Housekeeping on the board repository

The board is a git repository and every write is a commit, so an active project accumulates objects. Nothing breaks if you ignore this — git is designed for it — but two things are worth knowing.

cd "$(kanbanr where)"
git count-objects -vH      # loose objects and pack size
git gc                     # pack them; safe, and never touches your data

A board with a few hundred commits and no pack can hold a few thousand loose objects. git gc collapses that. It compacts storage and changes nothing about content — and it is not a way to reclaim anything: the logs keep every entry deliberately (one file per day under activity/ and events/), because raw data is never discarded. What is bounded is what a report shows you.

If you have a remote configured, an occasional kanbanr sync keeps the board pushed; kanbanr where --json tells you which folder is in use and why.

Troubleshooting

  • monitor not reachable from kanbanr open — start the view daemon first: kanbanr serve. The monitor is built into the binary, so there is no --ui-dir to find.
  • no commit identity for this board — kanbanr commits only as a real person. Set yours: kanbanr identity --name "You" --email you@example.com (or git’s own user.name and user.email). Boards made by older versions carry the placeholder kanbanr <kanbanr@local> in their git config; kanbanr doctor points it out, and the same command replaces it. Commits already made under the placeholder keep it unless you rewrite the board’s history.
  • could not determine project — pass --project, set $KANBANR_PROJECT, or kanbanr project use <name> (writes a .kanbanr marker).
  • project '…' not found / an empty board — you may be pointed at the wrong data folder. kanbanr where --json shows which folder is in use and why (--data-dir, $KANBANR_DATA_DIR, the marker, or the ./data fallback).
  • Push/pull conflicts — the data folder is a normal git repo; resolve in it with git as usual, then continue.
  • kanbanr: command not found — run make install and ensure ~/.cargo/bin is on PATH.
  • A move was rejected — the transition isn’t allowed; check kanbanr config show.
  • A feature add was rejected — every feature needs an existing --milestone.

See the architecture overview and the on-disk layout.