Skip to content

majordomus completion init

The shell integration to load once, which carries no command of its own and asks this executable for every candidate

majordomus completion init

Usage

majordomus completion init [OPTIONS]

Arguments

argumentvaluedefaultdescription
--shell zsh | bash | fish zsh Which shell to print the integration for
  • zsh — zsh
  • bash — bash
  • fish — fish
--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)

Examples

  • The same, for bash

    A different shell's protocol, the same question. Both adapters read the words being completed, find the cursor, ask this executable and print what comes back.

    $ majordomus completion init --shell bash

    What it asserts: exits 0; prints completion query, complete -F.

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