Forge the setup. Keep the evidence. Earn the release.
Armorer is building repeatable secure CI and verifiable releases for Rust repositories. Start with explicit intent. Preserve customizations. Hold the gate when required evidence is missing. A release must stand on its own proof.
This is the way.
Read-only check and plan validate explicit Cargo workspace selections; preview shows exact before/after text and complete diffs. Version-one apply manages the toolchain. The accepted version-two bootstrap path provisions all five local CI/build files from reviewed catalog pins and owner-selected policy. upgrade preserves stored generated bases, exposes conflicts and supports explicit imports and rollback. The strict complete-release consumer verifies independent context, authenticated inventories, exact assets and paired SBOM/graph evidence. Native Apple executable verification requires macOS. Follow the source map and acceptance ledger for accepted heads and operational gates.
v0.1 targets SLSA Build L2. Current main claims no SLSA level. L3 belongs to a future-version backlog item. Configuration, hosted CI, release rehearsal, publication and verified provenance each need separate evidence.
Start from a reviewed checkout with Rust 1.95.0 installed through rustup:
rustup run 1.95.0 cargo build --locked
./target/debug/armorer --help
./target/debug/armorer schema configThe owner's workstation prefixes shell commands with rtk; use rtk proxy rustup run 1.95.0 cargo build --locked there. If an unavailable compiler wrapper blocks the build, follow the contributor setup.
Bring a consuming workspace. Author armorer.toml using the CLI example. Name the repository, packages, binaries, targets and feature sets explicitly. Libraries omit binary; CLI and service deliverables require it.
./target/debug/armorer --repository /path/to/workspace plan
./target/debug/armorer --repository /path/to/workspace plan --preview
./target/debug/armorer --repository /path/to/workspace checkRead the JSON. plan exits 0 for valid inspection, including unmet setup requirements. check exits 2 for every valid inspection in this development version because release readiness remains blocked. Invalid input/discovery exits 1 with a JSON error. Argument errors use Clap's stderr diagnostics. Check and plan preserve consuming files, contact no GitHub service, and run no repository build scripts.
Follow your first inspection for a complete local exercise. Before changing a real project, read reviewed apply and recovery. Inspect the plan. Retain the approved digest. Apply the exact intent.
This is the way.
| Your task | Your guide |
|---|---|
| Inspect a Rust workspace | Onboarding |
| Select a library, CLI or service | Profiles and workspace walkthrough |
| Find commands, exit statuses and finding codes | CLI reference |
| Resolve a stopped inspection or transaction | Troubleshooting |
| Check contract and platform support | Compatibility, platform prerequisites |
| Apply a plan or recover a transaction | Apply and recovery |
| Inspect the bootstrap authority | Catalog source and limits |
| Verify an individual attestation through the library | Offline verifier |
| Understand configuration, locks and plan digests | Version-one contracts |
| Understand release trust and evidence | Trust contracts |
| Provision all five local files | Bootstrap and recovery |
| Review upgrades, imports and rollback | Upgrades |
| Verify complete or historical release bytes | Complete verifier, explicit historical policy |
| Inspect owned-draft publication gates | Controller |
| Review accepted source and remaining work | Development map |
| Contribute code or documentation | Contributing, writing creed |
The documentation index also leads to architecture, ADRs, research, the v0.1 acceptance ledger and retained validation records.
The public MIT repositories are armorer for the Rust CLI and armorer-workflows for separately versioned trusted reusable workflows. Momus and Rusty Brain are planned pilots.
Work is tracked in Veans project 16 under epic #1. Merges and release publication require explicit human authorization. Keep credential values with their owner. Build protection into the tools. Make every claim answer to evidence.
This is the way.