Skip to content

majordomus commands list

Every command, one line each: what it is, what running it changes, and where it is projected

majordomus commands list

Usage

majordomus commands list [OPTIONS]

Arguments

argumentvaluedefaultdescription
--origin executable | tool | workflow Only the commands of this program
  • executable — This executable
  • tool — The shell tool, bin/majordomus
  • workflow — A workflow the repository declares
--effect read-only | local-mutation | repository-mutation | network-mutation | destructive Only the commands whose effect is at most this
  • read-only — Reads and answers
  • local-mutation — Writes only what no commit carries
  • repository-mutation — Writes tracked files
  • network-mutation — Reaches the network with an effect
  • destructive — Removes something
--search <TEXT> Only the commands matching this text, in their invocation, summary, tags or identity
--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)
--format text | json text Output shape (accepted by every subcommand)
  • text — Lines for a person
  • json — One JSON document, deterministic

Examples

  • Only what reads

    The filters are the graph's own vocabulary rather than a search over text: `--effect read-only` is every command that changes nothing anywhere, which is the same predicate the exposure policy uses to decide what a machine surface may call.

    $ majordomus commands list --effect read-only

    Verified by the example tests: exits 0; prints read-only.

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 commands list --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.