Skip to content

Missing doc strings for many top-level subcommands #1153

@wfchandler

Description

@wfchandler

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions