# AGENTS.md

A terminal workspace with batteries included

## Setup

```
cargo build
```

## Commands

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

## Layout

- `zellij-server/`            95 source files
- `zellij-utils/`             95 source files
- `default-plugins/`          76 source files
- `zellij-client/`            61 source files
- `zellij-integration-tests/` 52 source files
- `xtask/`                    10 source files

## Conventions

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

## Gotchas

- `zellij-server/src/screen.rs` is 539KB. 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.