Skip to content

majordomus completion query

The candidates for one command line, from the command graph. What a shell adapter calls on every TAB

majordomus completion query

Usage

majordomus completion query [OPTIONS] [WORD]

Arguments

argumentvaluedefaultdescription
--surface cli | workflow cli Which surface the words are spelled for
  • cli — The command line of either program
  • workflow — The workflow runner
--cursor <N> The index of the word the cursor is in; the default is a new word after the last
--format text | json text Output shape
  • text — Lines for a person
  • json — One JSON document, deterministic
<WORD> <WORD> The words of the command line, the program's own name first
--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

  • What a shell asks on every TAB

    The words of the command line and the position of the cursor; back come the candidates with their descriptions. The same call answers the workflow runner's completion with `--surface workflow`, resolving the recipe name to the command it bridges and then completing that command's own arguments.

    $ majordomus completion query --surface cli -- majordomus work

    Verified by the example tests: exits 0; prints worktree.

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 completion query --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.