# AGENTS.md

🐹 Clean, uninstall, analyze, optimize, and monitor your Mac. Free open-source CLI, plus a native Mac app.

## Setup

```
go mod download
```

## Commands

```
make mod-download
make build          # produce a build
make check          # lint and type check
make format         # format
make test           # run the test suite, must pass before any commit
make test-go
```

## Layout

- `cmd/`      55 source files
- `lib/`      41 source files
- `bin/`      10 source files
- `scripts/`  6 source files
- `tests/`    6 source files
- `internal/` 2 source files

## Conventions

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

## Gotchas

- `lib/clean/dev.sh` is 206KB. 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.