# AGENTS.md

GitNexus: The Zero-Server Code Intelligence Engine -       GitNexus is a client-side knowledge graph creator that runs entirely in your browser. Drop in a git repository (Github, Gitlab, Azure, Local) or ZIP file, and get an interactive knowledge graph with a built in Graph RAG Agent. Perfect for code exploration

## Setup

```
npm ci
```

## Commands

```
npm run lint               # lint
npm run format             # format
npm run prepare
npm run format:check
npm run lint:fix
npm run gitnexus:refresh
npm run gitnexus:full
```

## Layout

- `gitnexus/`                    4121 source files
- `gitnexus-web/`                119 source files
- `eval/`                        52 source files
- `gitnexus-shared/`             38 source files
- `gitnexus-claude-plugin/`      6 source files
- `gitnexus-cursor-integration/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.devcontainer/translate-plugin-registries.test.cjs`.
- CI defines what passing means. See `.github/workflows/build-tree-sitter-prebuilds.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `gitnexus/src/mcp/local/local-backend.ts` is 373KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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.