Documentation Index
Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt
Use this file to discover all available pages before exploring further.
Build Compass into your agent stack
Compass exposes two surfaces designed for non-UI workflows:Coding Assistant
LLM-optimized docs Cursor, Claude Code, Copilot, and other AI assistants can fetch directly. Drop a single URL into your project config and let the agent write the integration.
CLI
A scriptable command-line interface to every Compass endpoint. Use it for one-off queries, shell pipelines, CI jobs, or as the tool layer behind an autonomous agent.
Why both?
| Coding Assistant | CLI | |
|---|---|---|
| What it is | Reference docs in a format AI assistants understand | A binary that calls the API for you |
| Used by | Cursor, Claude Code, Copilot, ChatGPT | Humans in a terminal, shell scripts, AI agents calling tools |
| Best for | Generating integration code in your project | Inspecting state, scripting workflows, agent tool use |
| Output | Generated source code in your repo | JSON / table / TOON output to stdout |
Agent-friendly by design
The CLI ships with an--agent-mode flag that switches output to TOON (token-efficient) format and enables structured error messages. It auto-activates when the CLI detects it’s being invoked from a known agent environment (CLAUDE_CODE, CURSOR_AGENT, etc.) — so an agent calling compass earn earn-vaults ... gets parseable output without you having to configure anything.
See the CLI page for details.
Get Started
New to Compass? Start with the SDK quickstart.
API Reference
Browse every endpoint the CLI and SDKs wrap.