# AGENTS.md

The agent that grows with you

## Setup

```
npm ci
```

## Commands

```
npm run check             # lint and type check
npm run postinstall
npm run install:root
npm run install:web
npm run install:tui
npm run install:desktop
npm run audit:root
npm run audit:web
```

## Layout

- `tests/`      3367 source files
- `apps/`       2064 source files
- `ui-tui/`     467 source files
- `hermes_cli/` 290 source files
- `plugins/`    211 source files
- `agent/`      201 source files

## Conventions

- Tests live alongside the code they cover, following `apps/desktop/e2e/at-rest-connection-token.spec.ts`.
- CI defines what passing means. See `.github/workflows/ci-review-comment.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `gateway/run.py` is 1493KB. 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.