# AGENTS.md

ripgrep recursively searches directories for a regex pattern while respecting your gitignore

## Setup

```
cargo build
```

## Commands

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

## Layout

- `crates/` 96 source files
- `tests/`  13 source files
- `ci/`     1 source file
- `fuzz/`   1 source file
- `pkg/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `crates/ignore/tests/gitignore_matched_path_or_any_parents_tests.gitignore`.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/core/flags/defs.rs` is 241KB. 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.