Skip to content
Akno

Command reference

This table answers three questions: which command matches the user’s intent, whether it can change their knowledge base, and which model roles may be involved.

CommandPurposeKnowledge-base write?Model roles
initConfigure models, folder admission, and first-run actionsApproved index opt-insPreflight or approved index/recall roles
indexReconcile derived state with filesNo by defaultEmbedding, derive
recall <query>Find and rank cited page/document evidenceNoExpansion, embedding, reranker
answer <question>Return a direct grounded answer and citationsNoExpansion, embedding, answer; reranker opt-in
read <slug>Read one exact page or documentNoNone
listBrowse folders, pages, or a treeNoNone
graph [seed]Inspect bounded exact evidence paths and locatorsNoNone
timelineRetrieve authored events and typed document datesNoNone
context <query>Assemble broad context or precision-first automatic recallNoEmbedding; reranker at an ambiguous boundary
writeCreate, append, patch, or replace a pageYesVision for textless attachments only
remember <text>Extract durable knowledge and route itYes or held proposalMaintenance or derive, plus recall roles
folder <path>Declare a folder and its default policyYes, akno.jsoncNone
approve / declineResolve a held routing proposalApproval may writeDepends on the held action
forgetRetract a fact or trash a page/documentYesNone
undo <change-id>Restore exact bytes from a journalled changeYesNone
move <from> <to>Move a page and its owned documentsYesNone
ingest <path|url>Extract, name, route, store, and indexYesDerive; vision when needed
inboxProcess arrivals in configured routed foldersYesSame as ingest
adopt <document-id>Give an orphan document a minimal owned pagePolicy-dependent planMaintenance or derive
dreamRun the seven maintenance phasesDepends on policyMaintenance or derive
planInspect, revise, decide, apply, retire, or prune plansApply onlyNone after planning
serveRun watcher and operation doorsNo by itselfNone by itself
serviceInstall, inspect, or remove background jobsOutside the knowledge baseNone
doctorDiagnose health and preview read-only admission rulesCache onlyProbes configured roles
rules [path]Explain effective folder and maintenance policyNoNone
configPrint resolved, redacted configurationNoNone
benchMeasure latency and invented-corpus quality gatesOnly explicit write testRoles selected by target
redeployBuild, restart, and wait for the local serviceNoNone

Add --help to any command for its current flags and examples:

akno --help
akno recall --help
akno dream --help

Commands that support machine-readable output accept --json.

Global flags

FlagMeaning
--akno-path <path>Override the knowledge base for this invocation
--state-dir <path>Override disposable/durable operational state location
--jsonUse the command’s structured output
--connectRequire a running service; do not fall back in process
-h, --helpShow command help

When a command resolves an explicit memory or state directory, a running service must identify the same knowledge-base path in its handshake. Akno refuses a mismatched service instead of operating on the memory behind the default socket; pair --akno-path with that memory’s --state-dir when connecting.

Retrieval choices

  • Use recall when you want ranked evidence results or intend to synthesize with another model.
  • Use answer when you want Akno to answer a memory question and verify its support.
  • Use read when you already know the exact slug or document id.
  • Use graph when the relationship path matters more than page content.
  • Use timeline when time is the primary filter.
  • Use context --profile auto_recall from an agent host before a substantive turn with no explicit memory question.

See Reading memory for ranking, qualification, citations, and result-state details.

Write choices

  • Use write when destination and wording are already known.
  • Use remember when Akno must decide what is durable and where it belongs.
  • Treat no_writable_destination as an authorization hold, not an empty memory result: inspect the typed approval reason and name or admit a destination. requires_folder instead asks the caller to declare taxonomy.
  • maintenance.retain.fallback_page can provide one exact last-resort destination. It is used only after ordinary routing and managed-page creation fail, and only when page or folder policy independently admits it. akno doctor reports whether the configured fallback is ready.
  • Use ingest for a file, folder, or URL; use inbox for configured drop folders.
  • Use forget for a deliberate retraction and undo when reversing a known Akno change.
  • Use plan for maintenance decisions. approve and decline are for held remember/ingest routing proposals, not dream-plan items.
  • Use plan revise when the proposed destination and transformation are right but the exact result is not. It creates a guarded immutable revision inside the existing path/evidence scope and invalidates approval; it does not edit the knowledge base by itself.

See Writing and ingestion and The dream cycle.

Agent operations

The CLI names correspond to operations in the shared protocol registry. Agent hosts should discover schemas from MCP or use the typed client rather than constructing CLI arguments. Some operator-only surfaces—service management, journal listing, plan decisions, and broad private diagnostics—are intentionally not granted to an agent merely because it can call memory.

Search documentation