# AGENTS.md

simple terminal UI for git commands

## Setup

```
go mod download
```

## Commands

```
make build       # produce a build
make install
make run
make run-debug
make print-log
make unit-test
```

## Layout

- `pkg/`     1072 source files
- `vendor/`  860 source files
- `scripts/` 14 source files
- `cmd/`     2 source files
- `demo/`    1 source file

## Conventions

- Tests live alongside the code they cover, following `pkg/cheatsheet/generate_test.go`.
- CI defines what passing means. See `.github/workflows/check-required-label.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `vendor/golang.org/x/sys/windows/zerrors_windows.go` is 923KB. 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.