DocsReference
CLI reference
Every bbm-atlas command: the ones that ask a running server, the ones that start a server, and the ones that work locally.
Talking to a server
Most commands ask a running BBM-Atlas over HTTP and print its JSON answer, exiting 0 on success and 1 otherwise. Each takes --base-url (default http://localhost:8000, or BBM_ATLAS_CLI_BASE_URL) and --api-key (or BBM_ATLAS_CLI_API_KEY).
| Command | Does |
|---|---|
index PATH --name NAME | Index a repository; --full re-parses everything, --background queues a job |
job JOB_ID | A background job's progress; --cancel stops it |
list, show ID, delete ID | The indexed repositories; one in detail; delete one and everything indexed for it |
symbols ID PATH, symbol-at ID PATH LINE | A file's symbols; the symbol at a line |
search ID QUERY | Search a repository |
impact ID QUALIFIED_NAME | What a change affects: --max-depth, --relationship-type, --tests, --backend |
graph query|node|neighbors|path|cycles|god-nodes|communities|stats|ambiguous | The knowledge graph |
graph outcome, graph lessons | Say whether an answer helped; the lessons learned from it |
remember, recall, forget | Facts about a repository |
run-agent ID AGENT_TYPE INSTRUCTIONS | Run an agent task |
retrieve HASH | The original behind a compressed marker |
status, flags list, flags set NAME VALUE | The server's state; its feature flags |
health, ready | Liveness, and each store's readiness |
console | Open the web console in a browser |
Starting a server
| Command | Starts |
|---|---|
serve | The API, /mcp and the console (--host, --port), on the local store unless storage is configured |
mcp serve | The MCP tools over stdio, for hosts without HTTP |
proxy | The compression proxy for OpenAI and Anthropic clients (--port, default 8787) |
Working locally
| Command | Does |
|---|---|
compress [PATH] | Compress a file or standard input; --simulate previews |
savings, dashboard | The tokens compression saved; an HTML dashboard of them |
learn LOG_PATH | Learn from a Claude Code, Codex, Gemini CLI or OpenCode session log: failures, the calls that fixed them and retry loops, written as corrections to CLAUDE.local.md (--target) |
migrate | Bring the configured stores up to date |
mcp install, mcp uninstall | Register BBM-Atlas with Claude Code for this project (--url for a running server) |
Enterprise
| Command | Does |
|---|---|
enterprise license | The licence's state, features and seats |
enterprise bootstrap EMAIL | Create the first administrator, while nobody exists |
enterprise whoami, enterprise roles | Who this key is; every role's permissions |
enterprise principals list|show|create-user|create-service-account|update | Users and service accounts |
enterprise keys list|create|revoke | Your keys, or another principal's with --principal |
enterprise organizations list|create | Organisations |
enterprise audit list|export|verify | The audit log |
bbm-atlas --version prints the version, and bbm-atlas <command> --help every option of a command.