Skip to content

majordomus mesh beat

Say a session is making progress, and what it is doing, so its exclusive claims keep excluding

majordomus mesh beat

Usage

majordomus mesh beat [OPTIONS]

Arguments

argumentvaluedefaultdescription
--session <SESSION> required The session making progress, as it was claimed under
--phase <PHASE> — What it is doing, one line: `waiting on CI run 123`
--pid <PID> — The running process of this machine the beat speaks for
--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 `text` for a person, `json` for a machine; both render the same answer
  • text — Lines for a person
  • json — One JSON document, deterministic

Examples

  • Keep a waiting session's exclusive claims excluding

    A process that waits on something outside itself says so; its session's exclusive claims hold while it beats within the progress ttl and are suspended when it stops. The beat goes to the running server whose journal replicates it; without one the command exits 10 and says so.

    $ majordomus mesh beat --session lander --phase waiting-on-ci

    What it asserts: exits 10.

    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 mesh beat --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.