Reference¶
Technical specifications for hyrum’s command-line surface, the hyrum.toml configuration file, the structure of run output, the charms and dependency formats it supports, the repository layouts and filters that decide which charms run, and the protocols to implement when extending hyrum.
- CLI reference
Every command-line option with full descriptions.
- Configuration reference
The
hyrum.tomlconfiguration file format and all supported keys.- Output reference
Outcome statuses, summary table format, verbose output, and log file format.
- Supported charms
The dependency declarations, patch subjects, testing frameworks, and runner backends hyrum supports.
- Charm discovery and filtering
The repository layouts hyrum recognises and the order its skip filters are applied in.
- Extending hyrum
The
PatcherandRunnerprotocols, for adapting or extending hyrum.