An option to `help` to partially silence output
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 40.5k
- Forks
- 2.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 85
Description
Related problem
I use such pattern a lot in my scripts, which gives nice subcommands experience
def main {
help main
}
def "main foo" {
# do something
}
There's one annoyance though: help command always outputs a table with input/output types. Such a table is useless for scripts because a script can only output text, but takes a lot of space in the output:
~ ❯ ./script
Usage:
> script
Subcommands:
script foo -
Flags:
-h, --help: Display the help message for this command
Input/output types:
╭───┬───────┬────────╮
│ # │ input │ output │
├───┼───────┼────────┤
│ 0 │ any │ any │
╰───┴───────┴────────╯
Describe the solution you'd like
It would be great to skip the types table in the help output via:
- either an option:
help --skip-types - or autodetection of the
helpbeing invoked in themainfunction of a script
To me 1 seems much simpler.
Describe alternatives you've considered
No response
Additional context and details
No response
Contributor guide
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 at the help command entry point and trace how its output, especially the input/output types table, is assembled. Review how existing help options are defined, then make the proposed option suppress that table while preserving the remaining help output and verify the behavior for the script pattern shown.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100