Repository navigation
feat(cli): show examples and a guide link in every command's help - #27
Open
thebrandonlucas wants to merge 1 commit into
Open
thebrandonlucas wants to merge 1 commit into
thebrandonlucas wants to merge 1 commit into
Conversation
thebrandonlucas
added this pull request to stack #25
October 13, 2026 19:03
This was referenced Oct 13, 2026
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 19, 2026 13:14
4bbca48 to
90628d2
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 19, 2026 13:15
90628d2 to
aee6c46
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
2 times, most recently
from
October 19, 2026 18:25
15a2ea8 to
8ba12a3
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 19, 2026 18:39
8ba12a3 to
06b70ce
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
2 times, most recently
from
October 19, 2026 19:11
5fe8242 to
cbe2165
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 19, 2026 19:19
cbe2165 to
25cc77f
Compare
This was referenced Oct 19, 2026
Every command that changes something now has examples in --help, each under a # comment that says what it does, as do login, auth import-key, profiles create, context, convert, payments get --wait, and checkout events watch. -h stays short: usage and options. --help adds the notes (request body, friendly flags, scope, feature requirement, examples) and a Learn more link to the command's guide in the docs of the running release. The root help lists common commands and links the documentation. Tests require an example for every change command and every alias, a Learn more link on every command that names an existing docs page, and no notes under -h.
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 00:20
25cc77f to
3fabe24
Compare
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.
Stack: master ← #20 ← #22 ← #24 ← #19 ← #26 ← this PR. Plan 07, phase 4 (help). Links to the wallet and webhook guides from #26.
payments send,payments receive,wallets createlogin,auth import-key,profiles create,context,convert,payments get --wait,checkout events watch; each under a# comment-h--help-hLearn more:Learn more: https://github.com/voltagecloud/voltage-cli/blob/v<version>/docs/<guide>, pinned to the running release--executerule, and a docs linkExamples live in one table keyed by
OperationId(endpoint_examples) pluslocal_examplesfor the CLI's own commands, so the parse test and help share one source.Tests:
--help.Learn morelink names a page that exists underdocs/.-hshows no notes.--executeor--dry-run.Validation:
cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata,cargo test --locked(95 unit, 69 integration), andpython3 scripts/check-coverage.py.Limit: links pin to the release tag, so a development build of an unreleased version links to pages that only exist once that version is tagged.