Skip to content

majordomus run

Run a capability as an execution and follow it: its steps, its progress and its output as they happen

majordomus run

Usage

majordomus run [OPTIONS] <CAPABILITY>

Arguments

argumentvaluedefaultdescription
--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)
<CAPABILITY> <CAPABILITY> required The capability to run, by its canonical id (`health.report`, `objects.verify`)
--input <JSON> Its input, as one JSON object; the capability's input schema is what validates it
--follow flag Print the events as they arrive on stderr; on by default when stderr is a terminal
--quiet flag Print nothing but the final output
--format text | json text Output shape
  • text — Lines for a person
  • json — One JSON document, deterministic

Examples

  • Watch an execution happen

    `run` starts a capability as an execution and follows it to its end: every step, every line it logs and every advance of its progress, as the handler reports them. `executions.demonstrate` exists to make that visible without waiting for real work — it reads nothing and writes nothing, and its only effect is the events it produces. The same execution, started from the Cockpit, streams the same events to a browser.

    $ majordomus run executions.demonstrate --input '{"steps":2,"delay_ms":0}' --format json

    Verified by the example tests: exits 0; prints one JSON document carrying /state, /id, /output/steps, /steps/0/name.

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