Skip to content

majordomus bench coverage

Every required target and whether it is covered; the denominator is generated from the registry

majordomus bench coverage

Usage

majordomus bench coverage [OPTIONS]

Arguments

argumentvaluedefaultdescription
--format text | json text Output shape
  • text — Lines for a person
  • json — One JSON document, deterministic
--check flag — Exit 10 when any required target is missing or waived
--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)
  • 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)

Examples

  • Every required benchmark target and whether it is covered

    The denominator is generated from the registry: every executable capability, on every transport it is exposed on, plus the transports' own operations.

    $ majordomus bench coverage --format json

    Verified by the example tests: exits 0; prints one JSON document carrying /lines, /tallies.

  • Fail when a target is missing

    Exit 10 when any required target is uncovered or waived, so a capability that nothing times cannot be merged.

    $ majordomus bench coverage --check

    Verified by the example tests: exits 0.

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 bench coverage --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.