# AGENTS.md

:cherry_blossom: A command-line fuzzy finder

## Setup

```
go mod download
```

## Commands

```
make test    # run the test suite, must pass before any commit
make itest
make fuzz
make bench
make lint    # lint
make fmt
```

## Layout

- `src/`   88 source files
- `test/`  12 source files
- `shell/` 4 source files
- `bin/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `src/algo/algo_test.go`.
- CI defines what passing means. See `.github/workflows/codeql-analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/terminal.go` is 247KB. 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.