docs: refresh CLI help blocks + fix dvs_status R signature#189
Closed
CGMossa wants to merge 1 commit into
Closed
Conversation
- specs.md: refresh all CLI help blocks against the live binary; document --threads (with pre/post-subcommand placement note); add the missing [PATHS], -r/--recursive, --with-metadata for status; correct the dvs_status R signature. - dvs-rpkg/CLAUDE.md: fix stale dvs_status signature in the function table (was current/absent/unsynced; now paths/recursive/status).
CGMossa
added a commit
that referenced
this pull request
May 4, 2026
specs.md and dvs-rpkg/CLAUDE.md are split into a docs-only PR (#189); this branch keeps only the CLI-side changes (display_order on globals, ui/main_cli_help.sh, justfile ui-publish-only fix).
5 tasks
CGMossa
added a commit
that referenced
this pull request
May 4, 2026
specs.md and dvs-rpkg/CLAUDE.md are split into a docs-only PR (#189); this branch keeps only the CLI-side changes (display_order on globals, ui/main_cli_help.sh, justfile ui-publish-only fix).
Contributor
Author
|
I need to find a meaningful way to provide an overview of this mess. |
CGMossa
added a commit
that referenced
this pull request
May 16, 2026
specs.md and dvs-rpkg/CLAUDE.md are split into a docs-only PR (#189); this branch keeps only the CLI-side changes (display_order on globals, ui/main_cli_help.sh, justfile ui-publish-only fix).
CGMossa
added a commit
that referenced
this pull request
May 16, 2026
Adds `ui/main_cli_help.sh` (139 lines) capturing the full `--help`
output for `dvs init / add / get / status` so the option-ordering
behavior of the current clap layout is pinned down and visible in
the published UI HTML. Anyone refactoring `CommonOpts` /
`Cli` / per-command structs has an obvious diff to compare against.
Supporting changes:
- dvs-cli/src/main.rs:
- `#[command(next_display_order = 100)]` on each subcommand so
per-command options render in a stable order regardless of
insertion order.
- `display_order = 0/1` on the two global flags (`--json`,
`--threads`) so they appear at the top of every command's
options block.
- justfile:
- Register `cli_help` in `ui_names` so `just ui-run` /
`ui-render` / `ui-publish` pick the new script up.
- `ui-publish-only`: conditionally include `ui/helpers.sh` as a
source attachment only when the target script actually sources
it (`main_cli_help.sh` doesn't).
Squashed from 10 commits (multiple reverts of an abandoned
CommonOpts flatten experiment + 2 cargo-fmt commits + doc churn
moved to #189) — the net diff is small and stands on its own.
CGMossa
added a commit
that referenced
this pull request
May 17, 2026
Adds `ui/main_cli_help.sh` (139 lines) capturing the full `--help`
output for `dvs init / add / get / status` so the option-ordering
behavior of the current clap layout is pinned down and visible in
the published UI HTML. Anyone refactoring `CommonOpts` /
`Cli` / per-command structs has an obvious diff to compare against.
Supporting changes:
- dvs-cli/src/main.rs:
- `#[command(next_display_order = 100)]` on each subcommand so
per-command options render in a stable order regardless of
insertion order.
- `display_order = 0/1` on the two global flags (`--json`,
`--threads`) so they appear at the top of every command's
options block.
- justfile:
- Register `cli_help` in `ui_names` so `just ui-run` /
`ui-render` / `ui-publish` pick the new script up.
- `ui-publish-only`: conditionally include `ui/helpers.sh` as a
source attachment only when the target script actually sources
it (`main_cli_help.sh` doesn't).
Squashed from 10 commits (multiple reverts of an abandoned
CommonOpts flatten experiment + 2 cargo-fmt commits + doc churn
moved to #189) — the net diff is small and stands on its own.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only refresh of
specs.mdagainst the live CLI binary, plus a one-line fix to the function table indvs-rpkg/CLAUDE.md. Split off from #188 so the docs land independently of the CLI option-ordering change.Changes
specs.md:--jsonand--threadsas global options (work pre- or post-subcommand) and call out the relationship toDVS_NUM_THREADS.<sub> --helpcode blocks to match the live binary output.dvs status: add the missing[PATHS]argument,-r / --recursive, and--with-metadataflag.[PATHS]/-r/--with-metadatasemantics forstatus.dvs_statusR signature:(paths, recursive, status)(was(current, absent, unsynced)— those are now folded into thestatuscharacter vector).dvs-rpkg/CLAUDE.md:dvs_statussignature in the function table.Test plan
specs.mdand verify the help blocks matchdvs <sub> --helpexactlydvs_statusR signature line indvs-rpkg/CLAUDE.mdmatchesR/dvs_status.R