majordomus ui
The UI in one step: ensure this checkout's shared server the way `serve ensure` does, print the address of `/ui` (or of `/ui/<screen>`) and open it in a browser
majordomus ui
Usage
majordomus ui [OPTIONS] [SCREEN]Arguments
| argument | value | default | description |
|---|---|---|---|
| --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) |
| <SCREEN> | <SCREEN> | — | The screen to open, by the last word of its route (`roadmap` is /ui/roadmap); without it, the dashboard |
| --no-open | flag | — | Print the address and open no browser |
| --port | <PORT> | — | The port a server this call starts asks for first, as for `serve ensure` |
| --idle | <SECONDS> | — | The idle life of a server this call starts, in seconds, as for `serve ensure` |
| --wait | <SECONDS> | 20 | How long to wait for a server to become ready |
| --format | text | json | text | Output shape
|
Examples
-
A screen the UI does not have is refused before a server is started
`majordomus ui` ensures this checkout's shared server as `serve ensure` does, prints the address of /ui (or of /ui/<screen>) and opens it in a browser; `--no-open` only prints it. A screen is named by the last word of its route, and one the navigation does not hold is refused with exit 2 and every screen listed, before the repository is read or anything is started.
$ majordomus ui nowhere --no-openWhat it asserts: exits 2.
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 ui --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.