Skip to content

majordomus capabilities describe

One capability by canonical id: schemas, provenance, every projection

majordomus capabilities describe

Usage

majordomus capabilities describe [OPTIONS] <ID>

Arguments

argumentvaluedefaultdescription
<ID> <ID> required The canonical id
--format text | json text Output shape
  • text — Lines for a person
  • json — One JSON document, deterministic
--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)

Examples

  • One capability in full, by its canonical id

    Its kind, its input and output schemas, where it was composed, and every projection of it: the MCP tool or resource, the HTTP route, the CLI path.

    $ majordomus capabilities describe objects.get

    Verified by the example tests: exits 0; prints objects.get, GET /api/v1/object.

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 capabilities describe --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.