Skip to content

docs(spec): refresh CLI --help blocks for init/add/get/status#202

Merged
CGMossa merged 1 commit into
mainfrom
docs/specs-cli-help-blocks
May 17, 2026
Merged

docs(spec): refresh CLI --help blocks for init/add/get/status#202
CGMossa merged 1 commit into
mainfrom
docs/specs-cli-help-blocks

Conversation

@CGMossa
Copy link
Copy Markdown
Contributor

@CGMossa CGMossa commented May 16, 2026

Specs contained hypothesized CLI help message. Now we adjust the specs to the actual CLI help messages.

AI-written details

Summary

Carved out of #149. Regenerates all four ### <cmd>#### CLI blocks in specs.md from actual dvs <sub> --help output captured against current main. Mechanical refresh; no spec content invented.

What changed in each block:

  • init: adds the global --threads <THREADS> option.
  • add: adds --threads; adds the ❯ dvs add --help prompt line that was missing.
  • get: adds --threads; expanded column widths to match real clap output now that the longest label is --threads <THREADS>.
  • status: complete rewrite — new positional [PATHS]..., -r, --recursive, --with-metadata, expanded column widths, updated one-liner ("Gets the status of each files in the current repository"), and the "By default shows all tracked files; use the flags below to filter" paragraph is gone (replaced by the prose paragraph below the block, which is unchanged).
  • All four fenced blocks: consistent ```shell language tag (was bare ```), consistent prompt prefix. Three U+F432 Nerd Font glyphs left over from the original terminal copy-paste are stripped.

Test plan

  • specs.md renders cleanly on GitHub
  • Each block matches ./target/release/dvs <sub> --help byte-for-byte (modulo the leading ❯ dvs <sub> --help prompt line)
  • perl -CSD -ne 'print "$.: PUA\n" if /[\x{E000}-\x{F8FF}]/' specs.md returns nothing

Drafted by Claude (claude-opus-4-7). Reviewed by the author.

Regenerated from actual `dvs <sub> --help` output. All four blocks
now reflect:

- the global `--threads <THREADS>` option (init/add/get/status)
- get/status's expanded column widths from the longer --threads label
- status's new positional `[PATHS]...` + `-r, --recursive` +
  `--with-metadata` flags
- status's updated one-liner ("Gets the status of each files in the
  current repository") and removed "By default shows all tracked
  files..." paragraph
- consistent `shell` language tag on the fenced blocks
- consistent `❯` prompt (stripped stray U+F432 Nerd Font glyphs from
  the original copy-paste)

Carved out of #149.
@CGMossa CGMossa merged commit 9bd3ce4 into main May 17, 2026
1 check passed
@CGMossa CGMossa deleted the docs/specs-cli-help-blocks branch May 17, 2026 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant