Repository navigation
Home
Local codebase intelligence system: structural graph + compass + wiki + agent memory. Runs entirely on your machine. No network calls, no torch in the default install.
cairn parses your repos with tree-sitter into a precise, language-aware
structural graph (symbols, call edges, definitions, blast radius) stored in
SQLite, then layers a compass (per-module navigation guides), a wiki
(architecture docs), memory (decisions / patterns / mistakes / workarounds),
and a knowledge store on top. The same store backs the cairn CLI and a
27-tool MCP server — making it agent-first: your coding agents query one
local source of truth instead of re-reading the whole repo every turn.
The authoritative docs live in the repo, version-pinned to each release.
This wiki holds only living / cross-version / contribution-oriented content and
defers to docs/ for everything technical. When in doubt, the tagged docs/
wins over the wiki.
| Topic | Read this | Lives in |
|---|---|---|
| Install + first run | Quickstart | docs/ |
| Every CLI command + flag | CLI reference | docs/ |
| The 28 MCP tools | MCP tools | docs/ |
Env vars + cairn.json
|
Configuration | docs/ |
| 5-layer design | Architecture · overview | docs/ |
| SCIP compiler-grade indexes | SCIP | docs/ |
| Resolution labels + worked example | walkthrough | docs/ |
| Performance methodology | Benchmarks | docs/ |
| Full release history | CHANGELOG | repo root |
Tip: replace
mainin those URLs with a specific tag (e.g.v0.6.1) to read the docs exactly as they shipped with that release.
| Page | What it's for |
|---|---|
| Home (this page) | Navigation + pointer to docs/
|
| Roadmap | Near-term plans + tracked issues. Changes every release. |
| Contributing & Codebase Map | Contributor tour of src/cairn/* — where to start reading. |
| FAQ & Troubleshooting | Common errors, install issues per client, known gaps. |
| Changelog Highlights | Curated, human-readable release summaries (full log in CHANGELOG.md). |
-
Install:
pip install cairn-intel(see Quickstart) - Report a bug / request a feature: GitHub Issues
- Report a security issue: SECURITY.md (private advisory, not a public issue)
- Contribute: CONTRIBUTING.md + this wiki's contributing page
Beta — pre-1.0. Public surfaces (CLI flags, MCP tool shapes, knowledge-file layout) may still shift before 1.0. Feedback welcome via GitHub issues.
MIT — © 2025–2026 Tan Le