spinel-coop/rv

Add back long help (in a more consistent way)

Open

#431 opened on Jan 28, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (46 forks)user submission
good first issue

Repository metrics

Stars
 (1,706 stars)
PR merge metrics
 (Avg merge 4d 18h) (14 merged PRs in 30d)

Description

Today, we have re-routed all four forms of help to only show the short help, the default clap provides on -h.

Instead, let's provide both long and short help, like this:

  • Global -h on any command, like rv ruby pin -h: show short help
  • Global --help on any command, like rv ruby pin --help: show short help
  • rv help [NAME], like rv help ruby pin: show long help
  • rv NAME help, like rv ruby help pin or rv ruby pin help: removed, it's confusing to have many help commands

Contributor guide

Research direction
Explore clap's help system configuration to differentiate between short and long help. Modify the command definitions to use `clap::Command::help template` and handle the ` help` flag to show short help while `rv help [subcommand]` shows long help. Check existing tests and update them accordingly.
Tech stack
rust
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75