# AGENTS.md

Rich is a Python library for rich text and beautiful formatting in the terminal.

## Setup

```
poetry install
```

## Commands

```
make test               # run the test suite, must pass before any commit
make test-no-cov
make format-check
make format             # format
make typecheck          # type check without emitting
make typecheck-report
```

## Layout

- `rich/`       100 source files
- `tests/`      67 source files
- `examples/`   36 source files
- `tools/`      5 source files
- `benchmarks/` 3 source files
- `docs/`       1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/__init__.py`.
- 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

- `rich/_emoji_codes.py` is 137KB. 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.