# AGENTS.md

Comfortably monitor your network traffic 🕵️‍♂️

## Setup

```
cargo build
```

## Commands

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

## Layout

- `src/`       158 source files
- `resources/` 3 source files

## Conventions

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

## Gotchas

- `src/translations/translations.rs` is 132KB. 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.