cairnmap 0.1.0__tar.gz

cairnmap-0.1.0/.gitignore

@@ -0,0 +1,29 @@
+__pycache__/
+*.pyc
+.venv/
+dist/
+.coverage
+coverage.xml
+htmlcov/
+.pytest_cache/
+.ruff_cache/
+/.cairn/
+.superpowers/
+bench/results/
+
+# OS and editor files
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# Build output
+build/
+*.egg-info/
+.mypy_cache/
+
+# Never commit secrets
+.env
+
+# Internal planning docs (kept locally, not published)
+docs/superpowers/

cairnmap-0.1.0/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+All notable changes to cairn are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and cairn uses
+[Semantic Versioning](https://semver.org/). Until 1.0, minor versions may change the map format;
+`.cairn/authored/` and `.cairn/relations.yaml` (what you write) stay compatible.
+
+## [Unreleased]
+
+## [0.1.0]
+
+First public release.
+
+### Added
+- **The map.** `cairn scan` maps every git repo under a folder into `.cairn/`:
+  - `INDEX.md` lists every repo in about 30 tokens per repo and is always loaded;
+  - each repo gets a card under `cards/<repo>.md`, read on demand;
+  - `workspace.json` holds the full graph.
+- **Relationships.** cairn finds links from shared packages, shared database tables, `../` path
+  references, and documentation mentions. Each link is tagged `extracted`, `inferred`, or
+  `ambiguous`.
+- **Settling links.** `cairn status` lists unconfirmed links. `cairn annotate-edge` confirms or
+  rejects them, and `cairn set-summary` saves a summary for a repo; both decisions survive
+  re-scans.
+- **Agent integrations.** `cairn install claude|codex|gemini|cursor|all` sets up each harness: the
+  index, a `/cairn` skill or command, and the cairn MCP server.
+  - The MCP server's tools are `resolve_repo`, `repo_card`, `related`, `find_across`, `query`, and
+    `refresh`.
+- **Freshness.**
+  - `cairn refresh` re-reads only the repos that changed.
+  - `cairn scan --full` re-reads everything.
+  - Opt-in git hooks (`cairn hooks install`) refresh the map after commits and merges.
+  - Summaries that may be stale are flagged.
+- **Benchmarks.** `cairn bench` runs headless Claude Code under five conditions, from no map to the
+  map plus MCP, and grades the answers deterministically. It ships with two suites:
+  - `shopverse` (6 repos);
+  - `fleetline` (15 repos).
+- `cairn --version` prints the cairn, Python, platform, and mcp versions.
+
+### Security
+- Text from scanned repos is treated as data:
+  - README text stays out of always-loaded context;
+  - folder and package names are flattened, capped, and stripped of markers, so they can't break
+    cairn's marked blocks.
+- cairn never reads through symlinks or junctions inside a repo, never opens `.env` files or
+  credential files, and redacts common secret formats from every snippet it stores.
+- Git calls disable `core.fsmonitor`, hooks, and the repo's own filters, and take no optional
+  locks.
+- A map committed inside a repo is never served.

cairnmap-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cairnmap-0.1.0/NOTICE

@@ -0,0 +1,6 @@
+cairn
+Copyright 2026 The cairn authors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+No third-party source code is vendored at this time. Any future vendored code
+will be listed here with its original copyright and license notice.

cairnmap-0.1.0/PKG-INFO

@@ -0,0 +1,352 @@
+Metadata-Version: 2.5
+Name: cairnmap
+Version: 0.1.0
+Summary: A workspace map for coding agents: every repo in a folder, how they connect, and where to look.
+Project-URL: Homepage, https://github.com/Moe1177/cairn
+Project-URL: Source, https://github.com/Moe1177/cairn
+Project-URL: Issues, https://github.com/Moe1177/cairn/issues
+Project-URL: Changelog, https://github.com/Moe1177/cairn/blob/main/CHANGELOG.md
+Author: The cairn authors
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai-agents,claude-code,codex,cursor,knowledge-graph,mcp,microservices,monorepo
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: mcp<3,>=2.3
+Requires-Dist: pathspec>=0.12
+Requires-Dist: pydantic>=2.11
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: typer>=0.16
+Description-Content-Type: text/markdown
+
+# cairn
+
+[![CI](https://github.com/Moe1177/cairn/actions/workflows/ci.yml/badge.svg)](https://github.com/Moe1177/cairn/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/cairnmap)](https://pypi.org/project/cairnmap/)
+[![Python](https://img.shields.io/pypi/pyversions/cairnmap)](https://pypi.org/project/cairnmap/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/Moe1177/cairn/blob/main/LICENSE)
+
+**A map of all your repos for coding agents.** cairn scans every git repo in a folder once, works
+out how they connect, and gives your agent:
+- a tiny always-loaded index;
+- a short card per repo.
+
+The agent knows where things live without re-exploring.
+
+> Cairns are the stacked-stone markers that guide hikers along a trail. cairn leaves small, cheap
+> markers that guide coding agents to the right repo, and then to the right file.
+
+Works with **Claude Code, Codex, Gemini CLI, and Cursor**, on **Windows, macOS, and Linux**.
+
+---
+
+## Why
+
+Coding agents work inside one repo. Real work spans many: a web app, an API, a shared types
+package, a payments service, a reporting job. Say *"add a tip amount to trips end to end"* and the
+agent has to:
+1. discover that sibling repos exist;
+2. grep through all of them;
+3. read a pile of files;
+4. guess which service owns the `trips` table.
+
+That costs tokens and turns, and weaker models guess wrong.
+
+Hand-maintained "related repos" docs help until they go stale. cairn builds that map from the code
+itself and keeps it fresh:
+
+```
+~/code/                          ~/code/.cairn/
+├── rider-web/        cairn      ├── INDEX.md           ← ~25 tokens per repo, always loaded
+├── trips-svc/        ─────▶     ├── cards/trips-svc.md ← read on demand (≤ 800 tokens)
+├── payments-svc/     scan       ├── workspace.json     ← the full graph
+├── analytics-etl/               └── authored/          ← your summaries and decisions
+└── …
+```
+
+## What your agent sees
+
+The **index** is a few lines, loaded into every session through `CLAUDE.md` or an equivalent:
+
+```markdown
+# Workspace repos (cairn)
+- admin-console (@fleetline/admin-console): Next.js back-office for ops staff; queries trips… · nextjs
+- analytics-etl: Nightly SQL reporting jobs over trips, payments, drivers… · python
+- payments-svc (payments): Go service that charges completed trips and records weekly payouts · go
+- trips-svc: FastAPI service owning the trip lifecycle and the trips/trip_events tables · fastapi
+- ui-kit (@fleetline/ui-kit): Shared React components (Button, Card) · react
+```
+
+A **card** is read only when the agent needs that repo:
+
+```markdown
+# trips-svc
+> FastAPI service owning the trip lifecycle and the trips/trip_events tables.
+`./trips-svc` · python, fastapi · HEAD 1fee22d
+
+## Relates
+← infra: references path trips-svc (extracted · infra/docker-compose.dev.yml:3)
+→ admin-console: shares tables trips (inferred · admin-console/lib/db.ts:4)
+→ analytics-etl: shares tables trips (inferred · analytics-etl/jobs/daily_revenue.sql:2)
+→ payments-svc: shares tables trips (inferred · payments-svc/internal/charge/charge.go:3)
+
+## Run
+test `pytest`
+
+## Layout
+app/ → routes/pages
+migrations/ → DB migrations
+```
+
+Every relationship comes with evidence (file and line) and a trust level:
+- `extracted`: found directly, such as a package dependency or a path reference;
+- `inferred`: strong signals, such as a table that only one repo creates;
+- `ambiguous`: hidden until you confirm it.
+
+## Install
+
+You need Python 3.11+ and git.
+
+| Tool | Command |
+|---|---|
+| [uv](https://docs.astral.sh/uv/) (recommended) | `uv tool install cairnmap` |
+| pipx | `pipx install cairnmap` |
+| run once, no install | `uvx --from cairnmap cairn init` |
+| pip | `pip install cairnmap` |
+
+The package is called `cairnmap`; the command is `cairn`.
+
+## Quick start
+
+```bash
+cd ~/code              # the folder that CONTAINS your repos
+cairn init             # scan, then add the index to ./CLAUDE.md (asks first)
+cairn install all      # optional: Codex, Gemini CLI, Cursor, the /cairn skill, the MCP server
+```
+
+Open your agent in any repo under that folder. It now knows about every sibling repo.
+
+To give each repo a good one-line summary, run `/cairn` inside your agent. It writes the summaries
+with `cairn set-summary` and settles uncertain links. Until then, the index says "no summary yet"
+for that repo. README text is deliberately kept out of always-loaded context.
+
+## How to use it
+
+### Day to day
+
+```bash
+cairn status               # repos, relationships, unconfirmed links, missing/stale summaries
+cairn refresh              # re-read only repos that changed (fast)
+cairn hooks install        # optional: refresh automatically after each commit/merge
+```
+
+### Settle uncertain links once
+
+```bash
+cairn annotate-edge "web->api:shares_db" --confirm
+cairn annotate-edge "shop->blog:shares_db" --reject --why "different databases"
+cairn set-summary payments-svc "Charges completed trips and pays drivers weekly." --alias payments
+```
+
+These decisions live in `.cairn/authored/` and `.cairn/relations.yaml`. They survive every re-scan,
+and you can commit them so your team shares them.
+
+### From your agent (MCP)
+
+`cairn install <harness>` registers cairn's MCP server. Agents can call these tools:
+
+| Tool | What it answers |
+|---|---|
+| `resolve_repo` | "Which repo is 'the payments service'?" |
+| `repo_card` | The card for a repo (re-scanned first if its HEAD moved) |
+| `related` | Everything connected to a repo, with evidence |
+| `find_across` | Which repos expose or use a table, package, or path |
+| `query` | Where to start looking inside a repo |
+| `refresh` | Update the map now |
+
+### What cairn detects
+
+| Signal | Examples |
+|---|---|
+| Package dependencies | npm (`workspace:*`, scoped packages), PyPI, Go modules, Cargo |
+| Shared database tables | SQL migrations and queries, Prisma, Drizzle, Supabase |
+| Path references | `../trips-svc` in docker-compose, tsconfig, and other config files |
+| Documentation | READMEs and docs that mention a sibling repo |
+
+Coming next: HTTP calls between services, infrastructure links, shared environment variables, and
+packages inside monorepos.
+
+## Benchmarks
+
+cairn ships a benchmark harness (`cairn bench`). It runs real tasks through headless Claude Code
+under five conditions, each in a fresh, isolated copy of a multi-repo workspace:
+
+| | Condition |
+|---|---|
+| **A** | No map (the agent explores) |
+| **B** | A hand-written "related repos" doc |
+| **C** | cairn's index only |
+| **D** | Index + repo cards |
+| **E** | D + cairn's MCP server |
+
+Tasks cover:
+- **orientation:** "who owns the trips table?";
+- **localization:** "which files change to add a tip amount end to end?";
+- **cross-repo impact:** "what breaks if `drivers.license_no` is renamed?";
+- **control:** questions answerable within one repo.
+
+Answers are graded deterministically on the files and facts they must name.
+
+**First results** on two synthetic workspaces, `shopverse` (6 repos) and `fleetline` (15 repos):
+
+| | Haiku 4.5 | Sonnet 5.5 | Opus 5.5 |
+|---|---|---|---|
+| Success, no map (A) | 89–96% | 100% | 100% |
+| Success, cairn index (C) | **100%** | **100%** | **100%** |
+| Best cairn cost vs no map | **−42%** (D) | **−24%** (C) | **−7%** (C) |
+
+What this shows so far:
+- **Weaker models gain accuracy.** Haiku went from missing 4–11% of tasks to 100%.
+- **The index alone is the most reliable condition** on every model and suite.
+- **Cost savings are modest on small workspaces.** Strong models with grep explore 6–15 small repos
+  in about 4 turns, and cairn's savings should grow with workspace size. These are first results:
+  3 runs per cell, no significance testing yet. The Opus runs cover shopverse only.
+
+Full tables, model ids, and caveats:
+[bench/published](https://github.com/Moe1177/cairn/blob/main/bench/published/2026-10-05-shopverse-fleetline.md).
+
+Run the benchmarks yourself from a source checkout. They use your Claude usage.
+
+```bash
+cairn bench bench/suites/fleetline --runs 3 --model haiku
+cairn bench bench/suites/shopverse --conditions A,C --tasks gift-message
+```
+
+## Safety and privacy
+
+cairn treats every scanned repo as untrusted input. It:
+- **never** modifies your repos, apart from the opt-in hooks and Cursor's `--per-repo` rule (both
+  marked blocks, removed cleanly);
+- **never** opens `.env` files, private keys, or credential files, and never reads through a symlink
+  or junction inside a repo;
+- **never** runs code from a repo: its git calls turn off fsmonitor, hooks, and the repo's own
+  filters.
+
+It also:
+- **redacts** common secret formats from every stored snippet, and stores git remotes without
+  credentials;
+- **keeps README text out** of always-loaded context. Repo names that do appear are flattened and
+  capped, so they can't inject instructions or break cairn's blocks.
+
+cairn makes **no network calls and collects no telemetry**. `cairn bench` is the only feature that
+runs another program that does (the `claude` CLI).
+
+See [SECURITY.md](https://github.com/Moe1177/cairn/blob/main/SECURITY.md) for the threat model and
+how to report a vulnerability.
+
+## Reference
+
+### Commands
+
+| Command | What it does |
+|---|---|
+| `cairn init` | Scan, then offer to add the index to Claude Code |
+| `cairn scan [--full] [--verbose]` | Map every repo under the folder into `.cairn/` |
+| `cairn refresh` | Re-read only repos whose HEAD or working tree changed |
+| `cairn status` | What cairn knows, unconfirmed links, missing or stale summaries |
+| `cairn annotate-edge KEY --confirm\|--reject [--why TEXT]` | Settle a relationship |
+| `cairn set-summary REPO TEXT [--alias NAME]` | Save a summary (`-` reads stdin) |
+| `cairn install <claude\|codex\|gemini\|cursor\|all>` | Load cairn into an agent harness |
+| `cairn uninstall <name\|all>` | Remove it again |
+| `cairn hooks install\|uninstall` | Opt-in git hooks that refresh after commits and merges |
+| `cairn serve` | The MCP server (harnesses start it for you) |
+| `cairn bench SUITE` | Run the benchmark harness |
+| `cairn --version` | Versions of cairn, Python, the platform, and mcp |
+
+**Exit codes:** `0` means success, `1` an error (one line on stderr), and `2` a usage error.
+
+### What cairn writes, and where
+
+| Path | What it is |
+|---|---|
+| `<folder>/.cairn/INDEX.md` | One line per repo: name, aliases, summary, stack |
+| `<folder>/.cairn/cards/<repo>.md` | One card per repo |
+| `<folder>/.cairn/workspace.json` | The full graph |
+| `<folder>/.cairn/cache/`, `logs/`, `.lock` | Scan cache, last scan log, lock file |
+| `<folder>/.cairn/relations.yaml`, `authored/` | **Yours:** aliases, manual links, summaries, decisions |
+| `<folder>/CLAUDE.md` | A marked block holding the index (`cairn install claude`) |
+| `~/.claude/skills/cairn/` and Claude's user MCP config | `/cairn` skill and MCP server |
+| `~/.codex/AGENTS.md`, `config.toml`, `skills/cairn/` | Codex pointer, MCP server, skill |
+| `~/.gemini/GEMINI.md`, `settings.json`, `commands/cairn.toml` | Gemini CLI pointer, MCP server, command |
+| `~/.cursor/mcp.json`, `commands/cairn.md` | Cursor MCP server and command |
+| `<repo>/.git/hooks/post-commit`, `post-merge` | Only with `cairn hooks install` |
+| `~/.cairn/registry.json`, `backups/` | Mapped workspaces; one private backup of each config file cairn first edited |
+
+cairn only edits its own key or marked block in other tools' files, and refuses to touch a file it
+can't parse.
+
+### Uninstall
+
+```bash
+cairn uninstall all          # harness entries, skills, commands, Cursor rules
+cairn hooks uninstall        # if you installed hooks
+uv tool uninstall cairnmap   # or: pipx uninstall cairnmap
+```
+
+Then delete `<folder>/.cairn/` and `~/.cairn/`.
+
+### Troubleshooting
+
+| Symptom | Fix |
+|---|---|
+| "No git repos found under …" | Run cairn from the folder that *contains* your repos |
+| "… is inside the git repository …" | Same: run from the parent folder, not inside a repo |
+| "git not found on PATH" warning | Install git; without it, remotes, HEAD and caching are off |
+| "another cairn process is still updating this workspace" | A scan or hook refresh is running; retry in a moment |
+| An agent says it can't find the workspace | Run `cairn init` in the workspace folder, then restart the agent session |
+| `cairn install codex/gemini/cursor` refuses a config | That file isn't valid TOML/JSON; fix it and re-run (cairn never guesses) |
+| Hooks did nothing | `cairn hooks install` lists the repos it skipped and why |
+
+## Roadmap
+
+1. ✅ Core map, precision pass, MCP server, harness integrations, freshness, benchmarks, release
+   hardening (0.1).
+2. HTTP, infrastructure and environment-variable relationships; packages inside monorepos.
+3. Deep per-repo queries via [graphify](https://github.com/Graphify-Labs/graphify).
+4. Larger benchmark suites (real open-source workspaces), significance testing, and more harnesses.
+
+## Contributing
+
+Issues and pull requests are welcome. See
+[CONTRIBUTING.md](https://github.com/Moe1177/cairn/blob/main/CONTRIBUTING.md) for setup and checks,
+and the [changelog](https://github.com/Moe1177/cairn/blob/main/CHANGELOG.md) for what's new. By
+participating you agree to the
+[code of conduct](https://github.com/Moe1177/cairn/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+cairn is licensed under the **Apache License 2.0**: use it, modify it, and ship it, commercially
+too. Keep the license and the [NOTICE](https://github.com/Moe1177/cairn/blob/main/NOTICE) file
+with any redistribution. Full text: [LICENSE](https://github.com/Moe1177/cairn/blob/main/LICENSE).
+
+Runtime dependencies and their licenses:
+
+| Package | License |
+|---|---|
+| [typer](https://github.com/fastapi/typer) | MIT |
+| [pydantic](https://github.com/pydantic/pydantic) | MIT |
+| [PyYAML](https://github.com/yaml/pyyaml) | MIT |
+| [pathspec](https://github.com/cpburnz/python-pathspec) | MPL-2.0 (used unmodified as a library) |
+| [mcp](https://github.com/modelcontextprotocol/python-sdk) | MIT |