# AGENTS.md

A smarter cd command. Supports all major shells.

## Setup

```
cargo build
```

## Commands

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

## Layout

- `src/`     23 source files
- `contrib/` 2 source files
- `tests/`   1 source file

## Conventions

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

---

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.