# AGENTS.md

👻 Ghostty is a fast, feature-rich, and cross-platform terminal emulator that uses platform-native UI and GPU acceleration.

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make init
make glad
make clean
```

## Layout

- `src/`     557 source files
- `macos/`   197 source files
- `pkg/`     193 source files
- `example/` 57 source files
- `include/` 35 source files
- `test/`    9 source files

## Conventions

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

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `src/terminal/PageList.zig` is 698KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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.