akm docs

Public API review — tracked issue backlog (v0.9.0-rc.10)

Status: proposed — reconciled 2026-07-26 against the maintainer rulings on Q-01..Q-19. Items carrying a > Ruled 2026-07-26 (Q-NN) note below are settled, re-scoped, or partially cancelled by a ruling; where a ruling bears on an item, the ruling is authoritative. Source: implementation-only review of the CLI surface and code (documentation claims deliberately ignored). Line references are against the tree at the time of review and may drift; each item names the file and the observable behavior so it can be re-verified independently. Note: items below cite docs/agents/AGENTS.md / AGENTS.full.md. Those files were deleted during the 0.9.0 docs sweep — they fed nothing at runtime after R-006 and kept re-diverging from the embedded copy. Their still-true content now lives in src/assets/hints/cli-hints-full.md / cli-hints-short.md, which is what akm hints prints and what loadHints reads. Baseline: items were found against a8464f2 and re-verified 2026-07-26 against the base branch claude/0-9-0-release-review-bcjxxu @ 453a0ba, which has since fixed some of them. A further pass on 2026-07-27 @ 2d2edc1 (code identical to 453a0ba) re-checked the contested items individually and added > Status 2026-07-27: notes where the tree disagrees with the item as written — including two items this register had over- or under-reported (R-004 fixed-in-surface; R-046 superseded by the D6 ruling). Items carrying a Fixed / Reframed / Rejected on the base branch note have been re-checked; the rest were not re-verified individually and may have been incidentally affected. See the "Implementation status against the base branch" table in the companion drift register for per-ruling status. Companion: 0.9.0-docs-code-drift-register.md covers the docs-vs-code comparison this review deliberately excluded — including the intent questions (Q-01..Q-19) where the decision record and the code conflict. All 19 were ruled by the maintainer on 2026-07-26; see the "Maintainer rulings — 2026-07-26" table in that register for the authoritative direction.

Framing

This backlog evaluates akm as what it has grown into: a self-contained agent toolkit — one CLI that gives AI agents the capabilities that normally require a stack of tools and a database server (indexed knowledge retrieval, secret/env management, harness-agnostic workflow execution and delegation, scheduling), while staying agent-, harness-, and content-format-agnostic (e.g. OKF alongside markdown).

Under that identity, the env/secret manager, the workflow engine, the agent dispatcher, the OS-scheduler integration, and the improve loop are in-scope features, not scope creep, and no issue below asks for their removal. The identity instead raises the bar in three specific ways, and most of this backlog follows from them:

  1. Agents are the primary consumers. Machine-facing guidance (akm hints, rendered command suggestions, help text, completions) is the product's API documentation and its runtime behavior. Every place it misleads an agent is a P0, not a docs nit.
  2. The abstraction claims must hold at the seams. "Harness-agnostic" and "format-agnostic" are testable properties; half-wired normalizers and format special-cases are gaps in the core value proposition.
  3. An autonomous toolkit must be trustworthy by default. Defaults that schedule LLM rewrites, push git remotes, or mine other tools' session transcripts need explicit opt-in or loud disclosure.

Severity legend:

Counts: 9 × P0, 26 × P1, 21 × P2, 12 × P3 (68 tracked). The counts reflect the tier labels as written; two items carry ruling-driven re-tier recommendations not yet applied — R-045 (Q-18 makes it mandated feature work) and the --format half of R-050 (Q-04 makes it Stable-tier contract work, and the item should be split first). Recompute when those land.


A. Agent-facing guidance correctness (P0)


B. Broken or surprising command behavior (P1)


C. Trust and safety defaults (P1)


D. Abstraction-seam gaps (P2) — where the agnosticism claims leak


E. Verb semantics and surface coherence (P2)


F. Cleanup batch (P3)


Explicitly reclassified as in-scope (no issue filed)

Under the agent-toolkit identity, the following were reviewed and are not defects of scope, only subject to the coherence/safety issues above: akm env/akm secret (including run-injection and ${secret:} interpolation), akm agent and the ten harness integrations, the workflow engine including the brief/report external-driver protocol, akm tasks and its three OS backends, the improve/proposal/collapse-detector loop, and the health observability surface.

Also noted as genuinely strong and worth preserving: the journaled fs-transaction promotion/revert machinery, tar-extraction and website-crawl SSRF hardening, git-URL scheme allowlisting, the exact-path git staging in stash sync, the values-never-in-stdout secret discipline, and the uniform {ok, error, code, hint} error envelope.