Skip to Content

Hatchery documentation

Hatchery packs a package folder into an egg and publishes eggs to a registry. It also resolves versions and installs. One package can hold content for several tools, and each tool installs only its own part.

PageWhat it covers
ConceptsEggs, targets, requirements, variants, sources, minimum release age and trust
package.kdlThe manifest of one package
packages.kdlThe root manifest of a repository, with defaults, package locations and releases
hatchery.kdlThe registries an installation searches
eggs.lockWhat is installed and from where
RegistriesStatic registries, a git repository as a registry, publishing, signing and withdrawing
Command lineEvery command and flag, with a CI pipeline
Rust APIThe client, the three traits, Egg, publishing and the errors
PlaygroundA folder with example packages and a registry to try the command in
DecisionsWhat the formats left open and what Hatchery chose

Where to start

  • To try the command without setting anything up, run the playground.
  • To make a package, read package.kdl, then run hatchery pack.
  • To publish from CI, read the pipeline at the end of Command line and then Registries.
  • To install packages from your own program, read Rust API.
Edit on GitHub

Last updated on

On this page