# AGENTS.md

Pre-indexed code knowledge graph, auto syncs on code changes, for Claude Code, Codex, Gemini, Cursor, OpenCode, AntiGravity, Kiro, and Hermes Agent — fewer tokens, fewer tool calls, 100% local

## Setup

```
npm ci
```

## Commands

```
npm run dev            # run locally
npm run build          # produce a build
npm run test           # run the test suite, must pass before any commit
npm run preuninstall
npm run copy-assets
npm run build:kernel
npm run cli
npm run test:watch
```

## Layout

- `__tests__/`           301 source files
- `src/`                 181 source files
- `scripts/`             64 source files
- `codegraph-kernel/`    45 source files
- `telemetry-dashboard/` 13 source files
- `site/`                7 source files

## Conventions

- Tests live alongside the code they cover, following `__tests__/adaptive-explore-sizing.test.ts`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/deploy-site.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `codegraph-kernel/grammars/scala/parser.c` is 34151KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.