Technical docs for @stainless-code/codemap.
Start here: ../README.md (install, CLI, API, dev commands). This folder is deeper reference — pick a row below.
| File | Topic |
|---|---|
| why-codemap.md | Why index + SQL for agents (speed, tokens, accuracy) — good first read after the readme |
| architecture.md | Schema, layering, CLI internals, API, User config (Zod), parsers, Key Files |
| agents.md | codemap agents init — granular templates/agents → .agents/, per-file IDE symlink/copy, pointer files (codemap-pointer markers), --interactive, .gitignore / .codemap.* |
| benchmark.md | Indexing another project · Benchmark script · fixtures/minimal/ |
| packaging.md | CHANGELOG.md / dist/ / templates/ on npm, engines, Node vs Bun, Releases (Changesets) |
| roadmap.md | Forward-looking backlog (not a src/ inventory) |
| Topic | Canonical doc | Elsewhere |
|---|---|---|
| Runtime splits (SQLite, workers, globs, JSON config I/O) | packaging § Node vs Bun — the table lives here | architecture § Runtime links here; do not copy the table |
codemap.config.* shape / Zod validation |
architecture § User config | Root README § Configuration points here |
codemap agents init: --force on .agents/ (template file paths only), IDE matrix, per-file symlink/copy, templates/agents |
agents.md | Link here; do not paste the integration table into README or packaging |
CLAUDE.md / AGENTS.md / GEMINI.md / Copilot — managed codemap-pointer sections, merge vs --force |
agents.md § Pointer files | Link here; do not duplicate the situation table |
| End-user CLI (index, query, agents, flags, env) | ../README.md § CLI | architecture § CLI usage summarizes and links back |
- One topic per file; prefer relative links between these docs.
- Avoid stale file/symbol counts in narrative text — use
codemap query/bun run dev queryafter indexing; methodology tables in benchmark.md are fine. - This repo:
bun run devisbun src/index.ts;bun run build→ tsdown →dist/;bun run clean/bun run check-updates— .github/CONTRIBUTING.md. - Contributors: branch + PR into
main(CI),bun run check, JSDoc on public API.