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.
| Page | What it covers |
|---|---|
| Concepts | Eggs, targets, requirements, variants, sources, minimum release age and trust |
| package.kdl | The manifest of one package |
| packages.kdl | The root manifest of a repository, with defaults, package locations and releases |
| hatchery.kdl | The registries an installation searches |
| eggs.lock | What is installed and from where |
| Registries | Static registries, a git repository as a registry, publishing, signing and withdrawing |
| Command line | Every command and flag, with a CI pipeline |
| Rust API | The client, the three traits, Egg, publishing and the errors |
| Playground | A folder with example packages and a registry to try the command in |
| Decisions | What 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