majordomus web report ui-snapshot
The UI itself, read once at this commit and written as static pages a publication carries at /ui (ADR 0141)
majordomus web report ui-snapshot
Usage
majordomus web report ui-snapshot [OPTIONS]Arguments
| argument | value | default | description |
|---|---|---|---|
| --limit | <LIMIT> | 240 | The most pages to write: every screen and panel first, then what they link to |
| --budget-seconds | <BUDGET_SECONDS> | 180 | The most seconds to spend on the pages the screens link to; the screens and panels are written whatever they cost |
| --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)
|
| --only | <ONLY> | — | Only these surfaces, by discovered id (repeat or separate with commas) (accepted by every subcommand) |
| --exclude | <EXCLUDE> | — | Every surface except these, by discovered id (accepted by every subcommand) |
Examples
-
Read the UI once and write it as the pages a publication carries at /ui
Asks the UI in-process for every screen and panel and then, one page per family in turn until `--limit` pages or `--budget-seconds` are reached, for the pages they link to, and writes each as a file under target/web/ui-snapshot: links between them relative, a link only a running process answers led to the snapshot's page about the live UI, the script told not to read again, and every page stamped with the commit, the time and the executable that read it. The declaration beside it makes the directory a surface of every publication and of no process.
$ majordomus web report ui-snapshot --limit 20What it asserts: exits 0; prints web report, ui-snapshot.
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 web report ui-snapshot --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.