Documentation
¶
Overview ¶
Command kb opens the local terminal UI by default. Task CLI and MCP subcommands use the same SQLite store directly.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
ai
Package ai implements kb's model probe, skill runner, and board tools over the local store.
|
Package ai implements kb's model probe, skill runner, and board tools over the local store. |
|
board
Package board holds the kanban board model and its markdown wire codec.
|
Package board holds the kanban board model and its markdown wire codec. |
|
cliapp
Package cliapp implements the kb command-line interface against the local SQLite store.
|
Package cliapp implements the kb command-line interface against the local SQLite store. |
|
forge
Package forge implements configured, guarded issue imports and upstream drift checks for local UI workflows.
|
Package forge implements configured, guarded issue imports and upstream drift checks for local UI workflows. |
|
mcpserv
Package mcpserv exposes a user's kb board as an MCP server named "kb" over stdio, so agent harnesses can list, add, update, move, and delete tasks against the local SQLite store.
|
Package mcpserv exposes a user's kb board as an MCP server named "kb" over stdio, so agent harnesses can list, add, update, move, and delete tasks against the local SQLite store. |
|
project
Package project carries the project vocabulary every kb surface shares.
|
Package project carries the project vocabulary every kb surface shares. |
|
store
Package store persists kanban boards, labels, and per-user AI settings in a single SQLite database via modernc.org/sqlite (pure Go, WAL mode).
|
Package store persists kanban boards, labels, and per-user AI settings in a single SQLite database via modernc.org/sqlite (pure Go, WAL mode). |
|
tui
Package tui implements kb's full-screen terminal interface.
|
Package tui implements kb's full-screen terminal interface. |
|
tui/action
Package action owns kb's keyboard action registry: one table naming every action the board offers, the key that drives it, and the words that describe it.
|
Package action owns kb's keyboard action registry: one table naming every action the board offers, the key that drives it, and the words that describe it. |
|
tui/adrsplit
Package adrsplit implements the direct-runner ADR-to-stories review overlay.
|
Package adrsplit implements the direct-runner ADR-to-stories review overlay. |
|
tui/carddetail
Package carddetail renders the full-card overlay and its direct-store comment and blocker-link actions.
|
Package carddetail renders the full-card overlay and its direct-store comment and blocker-link actions. |
|
tui/cardeditor
Package cardeditor implements the direct-store create and edit overlay.
|
Package cardeditor implements the direct-store create and edit overlay. |
|
tui/cmdpalette
Package cmdpalette renders kb's ctrl+k command palette: a fuzzy search over the action registry, elevated as the overlay of spec section 4.
|
Package cmdpalette renders kb's ctrl+k command palette: a fuzzy search over the action registry, elevated as the overlay of spec section 4. |
|
tui/formview
Package formview renders terminal form controls shared by TUI overlays.
|
Package formview renders terminal form controls shared by TUI overlays. |
|
tui/issueimport
Package issueimport implements the direct-store forge import review overlay.
|
Package issueimport implements the direct-store forge import review overlay. |
|
tui/mdparity
Package mdparity is the one grammar kb reduces a card description to before anything renders it.
|
Package mdparity is the one grammar kb reduces a card description to before anything renders it. |
|
tui/pointer
Package pointer maps rendered terminal cells to pointer interactions.
|
Package pointer maps rendered terminal cells to pointer interactions. |
|
tui/theme
Package theme owns kb's TUI design tokens: the semantic palette of docs/design/tui-design-spec.md section 1, the cached style factory of section 6, and the layout metrics and glyphs of section 2.
|
Package theme owns kb's TUI design tokens: the semantic palette of docs/design/tui-design-spec.md section 1, the cached style factory of section 6, and the layout metrics and glyphs of section 2. |
|
tui/widget
Package widget holds kb's hand-crafted TUI elements: the last resort of the charm-first sourcing rule of map #136, allowed only for the elements charm does not ship.
|
Package widget holds kb's hand-crafted TUI elements: the last resort of the charm-first sourcing rule of map #136, allowed only for the elements charm does not ship. |
|
tui/widget/spin
Package spin is the branded spinner engine of spec section 10.2.5: the gradient label that wipes in column by column while kb waits on a network round trip or a model inference.
|
Package spin is the branded spinner engine of spec section 10.2.5: the gradient label that wipes in column by column while kb waits on a network round trip or a model inference. |
|
scripts
|
|
|
ci/impactcmd
command
|
Click to show internal directories.
Click to hide internal directories.