Skip to content

CLI Reference

Lifecycle

CommandDescription
abmind installFirst-time setup of ~/.abmind (creates dirs, DB, templates)
abmind updateBuild current checkout, stage new release, flip symlink
abmind rollback [--to <version>]Flip current symlink to a prior release
abmind doctor [--fix]Health check — permissions, DB, ollama, templates. --fix auto-corrects.
abmind statusShow lifecycle status (version, lock state, symlink target)
abmind install-host <host>Install hooks into a host CLI (kiro, claude, gemini, codex)
abmind install-host <host> --uninstallRemove hooks from a host CLI

Memory Operations

CommandDescription
abmind recall --translated "keywords"Search memories (multi-stage recall pipeline)
abmind store --translated "content"Store a new extracted memory
abmind edit --id <id> [--content-en "..."]Edit an existing memory's fields
abmind ingest <file>Ingest a document into memory (extracts facts)
abmind embedBatch-embed all memories missing embeddings
abmind expand --id <id>Look up source messages by memory ID
abmind wake-upPrint current wake-up context (core identity + recent state)
abmind bundlePrint full session bundle (SOUL + profile + notes + memory tools)
abmind retro-extractExtract facts from retrospective/consolidation files
abmind migrate-openclawImport OpenClaw session transcripts (.jsonl format)

Sleep

CommandDescription
abmind sleep [--level <l>]Run a sleep cycle. Levels: basic, budget, normal, ultimate
abmind sleep-stateShow sleep candidates as JSON (what would be processed)
abmind sleep-apply [--promote] [--demote] [--dry-run]Promote/demote memories based on fitness
abmind sleep-reportGenerate dream report (summary of last sleep)

Sleep flags

FlagEffect
--level <l>Depth: basic (fast, minimal), budget (light), normal (standard), ultimate (thorough)
--dry-runGather state + build prompts, print to stdout, skip LLM calls
--verboseDetailed logging at each step
--forceRun housekeeping even if no new messages since last sleep

Secrets

CommandDescription
abmind list-secretsShow SECRET (class 3) memory metadata — no content, no decryption
abmind encrypt-secretsEncrypt existing classification=3 rows that aren't yet encrypted
abmind rekey --old-key <path>Re-encrypt all encrypted memories with a new key

Backup & Restore

CommandDescription
abmind backup [--database] [--output <path>]Create encrypted backup
abmind restore --input <path> [--mode merge|replace]Restore from encrypted backup

See backup.md for full options and examples.

MCP Server

bash
abmind mcp

Starts an MCP (Model Context Protocol) server on stdio. Exposes tools:

  • memory_recall — search memories
  • memory_store — store a new memory
  • memory_edit — edit an existing memory
  • memory_status — show memory stats
  • memory_wakeup — get wake-up context

Works with any MCP client (Cursor, Windsurf, Continue, Zed, etc.).

Hooks (Host Integration)

Used by Kiro CLI, Claude Code, and Gemini CLI for automatic memory integration:

CommandHook pointDescription
abmind hook-wakeupSession start (agentSpawn)Inject wake-up context into new session
abmind hook-recallBefore prompt (userPromptSubmit)Recall relevant memories for the current message
abmind hook-storeSession end (stop)Record the conversation turn
abmind hook-preToolUseBefore tool executionSecurity gate — blocks direct DB writes
abmind hook-postToolUseAfter tool executionCaptures tool context for memory extraction
abmind hook-doctorManualDiagnose hook config, errors, active sidecars

Global flags

These work with any subcommand:

FlagEffect
--helpShow usage for the subcommand

Environment

All commands respect ABMIND_HOME (default: ~/.abmind). See configuration.md for the full env var reference.

Exit codes

CodeMeaning
0Success
1Error (message printed to stderr)