Skip to content

Farrow documentation

Install Farrow, boot a Pigsty inventory, operate the one deployment, and look up the exact configuration and CLI contracts.

Farrow turns one Pigsty-compatible Inventory into fixed-IP QEMU virtual machines. It manages one deployment per Unix user; state lives under ~/.farrow, so lifecycle and SSH commands work from any directory.

Choose the shortest path for your task:

  • Start — install, first lab, daily changes, and troubleshooting.
  • Reference — exact Inventory fields, commands, flags, output, and exit codes.
  • About — simplified design, native validation, limits, and release gates.

New users should follow the tutorial. The complete normal path is farrow setup, farrow up, then farrow status.

Important

Farrow is pre-1.0. Current source behavior, native validation, packaging, release, and publication are separate gates. Read Status before depending on a development build.

Install Farrow, boot one or four nodes, operate the deployment, and resolve common failures.

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

The simplified product model, implementation boundaries, native evidence, current limits, and release gates.