# Reference

> Exact contracts for the Pigsty-compatible Inventory and Farrow command line.

---

LLMS index: [llms.txt](/llms.txt)

---

- [Configuration](configuration/) — discovery, accepted variables, defaults, disks, shares, naming, and drift.
- [CLI](cli/) — commands, important flags, output modes, and exit codes.
- [Images](images/) — signed catalogs, aliases, cache layout, pulls, imports, and pruning.
- [Image Pipeline](image-pipeline/) — candidate validation and offline normalization.

Farrow exposes no supported Go library API. Packages under `internal/` are
implementation details.

---

Section pages:

- [Configuration](/docs/reference/configuration/): The Pigsty-compatible Inventory fields Farrow reads, their defaults, and node-level drift behavior.
- [CLI](/docs/reference/cli/): Farrow commands, important flags, structured output, and exit codes.
- [Images](/docs/reference/images/): Signed catalogs, built-in aliases, repository selection, local cache verification, imports, and pruning.
- [Image Pipeline](/docs/reference/image-pipeline/): Validate or offline-normalize an explicit qcow2 candidate without downloading, uploading, or signing it.
