majordomus worktree inspect
One branch: its canonical path, whether it exists, what occupies the path, the worktree holding it, and what stands in the way
majordomus worktree inspect
Usage
majordomus worktree inspect [OPTIONS] <BRANCH>Arguments
| argument | value | default | description |
|---|---|---|---|
| <BRANCH> | <BRANCH> | required | The branch, full name |
| --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)
|
| --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)
|
Examples
-
One branch, before creating its worktree
Where the branch's worktree belongs, whether the branch exists, whether anything occupies the path, and what would stand in the way. For a branch that does not exist yet, the answer is the path `worktree create` would use and the command to run.
$ majordomus worktree inspect feature/new-dashboardVerified by the example tests: exits 0; prints -wt/feature/new-dashboard, does not exist yet.
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 worktree inspect --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.