oxidecomputer / oxidecomputer/oxide.rs

Flag or something to get help to show commands _and_ subcommands

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
75
Forks
21
Avg merge
2d 2h
Merged PRs (30d)
19

Description

I run help at top level

Screenshot 2023-03-03 at 7 47 08 PM

then I see some command I'm interested in, so I run it again for that command

Screenshot 2023-03-03 at 7 48 01 PM

Would be cool to have a way of getting it to show at least one level of subcommands from top level, so you're looking at the tree. That's basically what the docs do. (I guess that could be an argument either that it's unnecessary or that it's useful.) Probably shouldn't be the default, but maybe -hh or something stupidly cute like that.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Use the top-level and nested help examples in the issue, along with the linked CLI alias documentation, to clarify the desired command tree. Identify the CLI help entry point and determine how an optional flag such as -hh should expose one level of subcommands without changing the default; done means the output shows commands and subcommands as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.