Repository navigation
feat(cli): show examples and a guide link in every command's help - #27
Merged
Merged
Conversation
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
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 00:20
25cc77f to
3fabe24
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 11:59
3fabe24 to
2b58ccf
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 12:25
2b58ccf to
3128164
Compare
tee8z
self-requested a review
October 20, 2026 12:33
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 13:01
3128164 to
b836e6b
Compare
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
2 times, most recently
from
October 20, 2026 15:32
2254c01 to
2d41d78
Compare
tee8z
previously approved these changes
Oct 20, 2026
thebrandonlucas
dismissed
tee8z’s stale review
October 20, 2026 16:12
The merge-base changed after approval.
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 16:12
2d41d78 to
c8f935f
Compare
tee8z
self-requested a review
October 20, 2026 16:13
tee8z
previously approved these changes
Oct 20, 2026
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 16:36
c8f935f to
37b663d
Compare
tee8z
self-requested a review
October 20, 2026 16:49
tee8z
previously approved these changes
Oct 20, 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
dismissed
tee8z’s stale review
October 20, 2026 16:51
The merge-base changed after approval.
thebrandonlucas
force-pushed
the
feat/cli-help-examples
branch
from
October 20, 2026 16:51
37b663d to
3e6a8e7
Compare
tee8z
self-requested a review
October 20, 2026 16:52
tee8z
approved these changes
Oct 20, 2026
3 of 5 tasks
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
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 ← #26 ← #27 ← #28 ← #29 ← #30 ← #55 ← #60. #20, #22, #57, #24 and #19 are merged.
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/<ref>/docs/<guide>--executerule, and a docs linkDocs ref:
build.rsmakes one decision for--versionand the links. A clean build of a release tag linksv<version>; any other build, including one without a git checkout, linksmaster. The root docs link and everyLearn morelink use the same ref.Examples 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.-hno longer shows the friendly-flag requirements; they appear under--help.Tests:
--help.Learn morelink names a page that exists underdocs/, and the ref ismasterorv<version>, the same for the root link.-hshows no notes.--executeor--dry-run. feat(cli)!: remove --dry-run, and describe every help example offline #30 also runs every help example offline.Changes after review
checkout sessions create: the example read@session.jsonand wrote--output-file session.json, so it always failed with "File exists". It now reads@session-request.json.wallets policies: the round trip sent the CLI's output envelope back as the policy body. It now saves only the policies:voltage wallets policies get WALLET_ID --profile prod --json | jq .data > policies.json. The wallets guide says the same.blob/v0.1.0, a tag that has no guides, so every link failed. See "Docs ref" above.OperationId::paths instead of a function-scope glob import.CREDIT_LINE_IDas in the other examples.Checks
On
37b663d:cargo fmt --check,cargo clippy --locked --all-targets -- -D warnings,cargo machete --with-metadata: pass.cargo test --locked: 99 unit and 86 integration tests pass.VOLTAGE_BLESS=1 cargo test --lockedleaves the tree clean.python3 scripts/check-coverage.py: pass.scripts/crap-report.sh): no function at or above 20. Highest isapi::wait_for_paymentat 19.24, unchanged from or lower than master (19.66).voltage-pr-reviewand thevoltage-backend-engineeringRust checklist, against the stack base. Findings are fixed in this commit.Not run: the staging and live tutorials, which need credentials.