# AGENTS.md

an open source, extensible AI agent that goes beyond code suggestions - install, execute, edit, and test with any LLM

## Setup

```
cargo build
```

## Commands

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

## Layout

- `crates/`        553 source files
- `ui/`            499 source files
- `documentation/` 86 source files
- `services/`      19 source files
- `scripts/`       18 source files
- `examples/`      5 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/pr-smoke-test.yml`.
- CI defines what passing means. See `.github/workflows/build-cli-linux.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/goose/src/agents/agent.rs` is 249KB. 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.