Documentation
Everything to install, use and run BBM-Atlas
From your first indexed repository to a highly available deployment for many teams: guides for the Community and Enterprise Editions, and references for every command and route.
Start
Install BBM-Atlas and index your first repository.
Use
Assistants, the console, the editor and every setting.
- Connect your AI assistantGive Claude Code, VS Code, Cursor or any other MCP host BBM-Atlas's 32 tools, served by the running API at /mcp, on the same repositories you index.
- The web consoleThe browser UI served by the API at /console/: health, indexing, search, the graph explorer and impact analysis, and with the Enterprise Edition, people, organisations and the audit log.
- The VS Code extensionIndex the workspace, search it, and see what a change affects from the cursor or a code lens, with BBM-Atlas's tools offered to Copilot's agent mode.
- ConfigurationEvery setting is an environment variable starting with BBM_ATLAS_, also read from a .env file, with credentials readable from files.
Run
Serve a team safely, from one machine to Kubernetes.
- SecurityBBM-Atlas starts locked to this machine with no keys. Before anyone else can reach it: keys, the directories it may index, the host names it answers, HTTPS and limits.
- ProductionRun BBM-Atlas for a team: behind a reverse proxy on one machine, or on Kubernetes with the Helm chart, on one local store or on shared Postgres, Neo4j, Qdrant and Redis, observable throughout.
Enterprise
The licence, people and roles, sign-on, organisations, audit and availability.
- Licence and set-upTurn on the Enterprise Edition with a licence key checked offline, read its state, and create the first administrator.
- People, roles and keysUsers and service accounts, each with API keys of their own and one or more of five roles, managed from the CLI, the REST API or the console.
- Single sign-onPeople sign in to the console through your identity provider, with OIDC or SAML 2.0, and their roles follow their groups. Guides for Okta, Microsoft Entra ID, Google Workspace and Keycloak.
- OrganisationsSeveral teams on one deployment, each seeing only its own repositories and managing only its own people.
- The audit logEvery security-relevant event, append-only and hash-chained so tampering is detectable, filterable in the console and exportable to your SIEM.
- High availabilitySeveral API replicas behind a load balancer, on shared stores, with one queue of background index jobs that survives a replica stopping.
Reference
Every command and route, and what the messages mean.
- CLI referenceEvery bbm-atlas command: the ones that ask a running server, the ones that start a server, and the ones that work locally.
- REST APIThe routes under /api/v1, the response envelope every one of them uses, authentication and the errors to expect. Each server also documents itself at /docs.
- TroubleshootingWhat the messages BBM-Atlas prints mean, and what to do about them: the server, keys and roles, the local store, limits, single sign-on and the licence.
Can't find what you need?
Search the site with /, or write to us at info@byteblendmatrix.com.