# AGENTS.md

Lightweight Kubernetes

## Setup

```
go mod download
```

## Commands

```
make deps
make binary-size-check
make image-scan
make format              # format
make tag-image-latest
make validate
```

## Layout

- `pkg/`       264 source files
- `tests/`     72 source files
- `cmd/`       14 source files
- `scripts/`   7 source files
- `contrib/`   5 source files
- `updatecli/` 3 source files

## Conventions

- Tests live alongside the code they cover, following `cmd/k3s/main_test.go`.
- CI defines what passing means. See `.github/workflows/actionlint.yaml`, 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.