Skip to content

majordomus evidence stamp

Measure the checkout as a run left it, for `record --provenance`

majordomus evidence stamp

Usage

majordomus evidence stamp [OPTIONS]

Arguments

argumentvaluedefaultdescription
--producer <PRODUCER> — The producer whose run this is: suite, crate or coverage
--report <REPORT> — The report the run wrote
--exclude <EXCLUDE> — One of the run's own untracked outputs (a file, or a directory with everything under it)
--out <OUT> — Write the measurement 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)
  • vcs — Tracked files, through the version-control index (the layer's contract); a layer none of which is tracked is read from the work tree
  • filesystem — A walk of the work tree with the same glob semantics; untracked files included
--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)
  • text — Lines for a person
  • json — One JSON document, deterministic

Examples

  • What a run measured, as one document

    The measurement a runner takes when its run ends: the commit, the tree with the evidence ledger ignored and the run's own untracked outputs excluded, the producer, its toolchain, the recorder's version and the host. `evidence record --provenance` carries it into the executions of that run's report.

    $ majordomus evidence stamp --producer suite --format json

    What it asserts: exits 0; prints one JSON document carrying /producer, /commit, /working_tree, /recorder, /host.

    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 stamp --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.

Searches the titles and descriptions of every page this site publishes.