feat: Generate manpages based on clap command docs#2014
Merged
ianderson-nvidia merged 1 commit intoJun 1, 2026
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
ianderson-nvidia
force-pushed
the
admin_cli_updates_1
branch
2 times, most recently
from
8435646 to
c92ec8b
Compare
* Generate man pages for each command and subcommand (similar to
git man pages)
e.g. To view the man page of the command `carbide-admin-cli vpc show`
`man carbide-admin-cli-vpc-show`. To view the man page of the command
`carbide-admin-cli vpc set-virtualizer` man carbide-admin-cli-vpc-set-virtualizer
Uses can start with simply `man carbide-admin-cli` which will list
all commands available
* man pages for each command and subcommand are generated based on the `help` text of
clap. `after_long_help` is treated as "EXTRA" in man
pages, which is where we include example usages of CLI commands.
e.g. (example from viewing the man page of
`carbide-admin-cli-vpc-show`)
```
EXTRA
List all VPCs:
$ carbide-admin-cli vpc show
Show details for one VPC
$ carbide-admin-cli vpc show 12345678-1234-5678-90ab-cdef01234567
Filter by tenant org
$ carbide-admin-cli vpc show --tenant-org-id fds34511233a
Filter by label:
$ carbide-admin-cli vpc show --label-key env --label-value prod
```
ianderson-nvidia
force-pushed
the
admin_cli_updates_1
branch
from
c92ec8b to
3ec6052
Compare
kensimon
approved these changes
Jun 1, 2026
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
2 participants
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.
carbide-admin-cli vpc showman carbide-admin-cli-vpc-show. To view the man page of the commandcarbide-admin-cli vpc set-virtualizerman carbide-admin-cli-vpc-set-virtualizer Uses can start with simplyman carbide-admin-cliwhich will list all commands availablehelptext ofclap.
after_long_helpis treated as "EXTRA" in manpages, which is where we include example usages of CLI commands.
e.g. (example from viewing the man page of
carbide-admin-cli-vpc-show)Description
Type of Change
Related Issues (Optional)
Breaking Changes
Testing
Additional Notes
Related to #2011