# AGENTS.md

Open-source coding agent for your terminal, built in Rust and on a journey of continuous community improvement. Issues and PRs welcome.

## Setup

```
npm ci
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `crates/`           932 source files
- `web/`              229 source files
- `scripts/`          83 source files
- `integrations/`     22 source files
- `npm/`              17 source files
- `telemetry-ingest/` 13 source files

## Conventions

- Tests live alongside the code they cover, following `.github/scripts/agent-task-metadata.test.sh`.
- CI defines what passing means. See `.github/workflows/agent-task-labels.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `patches/unicode-width-0.2.2/src/tables.rs` is 1527KB. 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.