majordomus evidence record
Record a run that happened into the ledger
majordomus evidence record
Usage
majordomus evidence record [OPTIONS]Arguments
| argument | value | default | description |
|---|---|---|---|
| --suite | <SUITE> | — | The runner's TSV report (`MJ_TEST_REPORT=<file> bash test/run.sh`) |
| --crate-output | <CRATE_OUTPUT> | — | A file holding `cargo test`'s output, for the crate's own integration tests |
| --origin | <ORIGIN> | — | Where the run happened: local (the default), ci or release |
| --provenance | <[PRODUCER=]FILE> | — | The file `evidence stamp --out` wrote; prefix `suite=`, `crate=` or `coverage=` when the file names no producer and several reports are given |
| --coverage | <COVERAGE> | — | The summary `scripts/rust-coverage --summary-json` wrote |
| --ledger | <LEDGER> | — | repo (the default) or local |
| --run-record | <RUN_RECORD> | — | Also write the run record to this file |
| --repo | <PATH> | — | Start the search for the repository root here (default: the current directory) (accepted by every subcommand) |
| --discovery | vcs | filesystem | vcs | How declarative files are enumerated (accepted by every subcommand)
|
| --strict | flag | — | Refuse to proceed when any file of the layer carries an error diagnostic (accepted by every subcommand) |
| --share | <DIR> | — | The tool distribution's share directory (kinds.yaml, schemas/); default: $MAJORDOMUS_SHARE, then the repository's own share/, then the one beside the executable (accepted by every subcommand) |
| --format | text | json | text | Output shape (accepted by every subcommand)
|
Examples
-
Recording a report that is not there
The recorder reads what a run already wrote — the suite's TSV report, `cargo test`'s output — and stamps it with the provenance the run did not carry. A report it cannot read is refused: recording nothing would leave every claim reading `not run` after a run that ran, which is a lie in the safe direction and still a lie.
$ majordomus evidence record --suite target/no-such-run.tsvWhat it asserts: exits 13.
Tested by apps/majordomus-cli/tests/cli_examples.rs, which runs the command against the built executable and asserts what the page states.
Where this comes from
Declared once in apps/majordomus-cli/src/cli.rs: clap for the structure, typed Rust metadata beside it for the examples. This page, majordomus evidence record --help, docs/generated/cli.md and docs/generated/cli.json are projections of that one declaration.
The whole command line on one page: the registry's command-line page. The task lifecycle (init, start, finish, doctor, ...) belongs to the shell tool, a different program: Commands and its specification.