Skip to content

majordomus served observe

Probe the build identity a deployment serves, judge it against a commit and record it

majordomus served observe

Usage

majordomus served observe [OPTIONS]

Arguments

argumentvaluedefaultdescription
--commit <COMMIT> — The commit expected to be served (default HEAD)
--url <URL> — The site's base URL (default: base_url of site/config.toml)
--identity <IDENTITY> — The identity file under the base (default build.json)
--deployment <DEPLOYMENT> — The name the observation is recorded under (default pages)
--timeout <TIMEOUT> — Bound on the probe, in seconds (default 10)
--dry-run flag — Judge without recording
--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

  • A deployment that could not be reached is not a deployment that is current

    One bounded probe of the build identity under the base URL, judged against HEAD. Nothing listens on the discard port, so nothing is received and the verdict is `unreachable` with exit 12 — the unanswered question, never the yes. `--dry-run` judges without recording. Against the public site the same command answers `served` (0) when the build contains the commit and `stale` (10) when it does not.

    $ majordomus served observe --url http://127.0.0.1:9 --timeout 1 --dry-run

    What it asserts: exits 12.

    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 served observe --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.