oxidecomputer / oxidecomputer/oxide.rs
Missing doc strings for many top-level subcommands
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 75
- Forks
- 21
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 19
Description
Component
- CLI
- SDK
- Something else
- Not sure
What was the expected behaviour
All Oxide CLI commands have a doc string.
What is the current behaviour and what actions did you take to get there
Many top-level subcommands do not have a doc string, which makes autocomplete for the oxide command rather unhelpful.
$ oxide^I
api -- Makes an authenticated HTTP request to the Oxide API and prints the response.
auth -- Login, logout, and get the status of your authentication.
completion -- Generate shell completion scripts for Oxide CLI commands.
docs -- Generate CLI docs in JSON format
experimental instance snapshot ip-pool bundle alert disk user silo vpc
internet-gateway auth-settings current-user floating-ip certificate project policy image group
system --
help -- Print this message or the help of the given subcommand(s)
ping -- Ping API
utilization -- Fetch resource utilization for user's current silo
version -- Prints version information about the CLI.
CLI or SDK version
0.12.0+20250604.0.0
Operating system
macOS
Anything else you would like to add?
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching the Rust CLI command definitions for the top-level subcommands shown in the autocomplete output, especially experimental, system, and resource commands. Compare their help metadata with commands that already display descriptions, then verify that all top-level commands show doc strings in oxide autocomplete and help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100