Skip to content

majordomus scope

The repository scope: what a worker reads and what it never reads; with paths, whether each is in or out and why

majordomus scope

Usage

majordomus scope [OPTIONS] [PATHS]

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)
<PATHS> <PATHS> Repository-relative paths to judge; none prints the declaration and the tally
--format text | json text Output shape
  • text — Lines for a person
  • json — One JSON document, deterministic
--check flag Exit 10 when any path given is out of the scope

Examples

  • What a worker reads of this repository

    With no path, the declaration itself and the tally: how many tracked files are in the scope and how many are out.

    $ majordomus scope

    Verified by the example tests: exits 0.

  • Judge paths, and say which rule decided

    For each path: in or out, and the rule that decided it. `--check` exits 10 when any path given is out, which is how a hook refuses to read one.

    $ majordomus scope docs/CLI.md --format json

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

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