simcrux --help prints only the option table: no usage line, no subcommand list
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
Research direction
Start in lib/core/cli/simcrux_cli.dart at SimcruxCli.run: the HelpCliArgs branch prints CliArgParser().usage, and the "nothing to do" path prints the same block, so both need the new text. Add a top-level usage constant (Usage: simcrux <command> [options], each subcommand with a one-line description, then the option table) and print it from both paths. Add a test asserting the help text names every subcommand run dispatches on, so done means that test passes and subcommand help still exits 0.
Written by the indexing model from the issue text.
Description
Found while smoke-testing the 1.2.0 builds on Windows and Linux.
simcrux --help prints only the option table. There is no Usage: line and no list of the subcommands (import-sby, import-eqy, import-riscv-arch-test, import-riscv-formal, export-dashboard, license, flow). The subcommands only appear in the "nothing to do headless" error, so someone reading --help cannot discover them. The Pro CLI's --help prints a Usage: simcrux-pro <command> [options] line, every command, and each command's own text.
Where: lib/core/cli/simcrux_cli.dart, SimcruxCli.run. The HelpCliArgs branch prints CliArgParser().usage, which is the ArgParser option table and nothing else. The "nothing to do" path prints the same block.
Likely fix: a top-level usage constant with a Usage: simcrux <command> [options] line, the subcommand list with a one-line description each, then the option table. Print it for --help and for the no-work error. A test should assert the help text mentions every subcommand that run dispatches on, so a new subcommand cannot be added without being listed.
Subcommand help (simcrux import-sby -h, simcrux flow --help) already works and exits 0.
Found in 1.2.0.
- Dominant language
- Dart
- Stars
- 0
- Forks
- 0
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from Ferrite-Engineering/simcrux
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Check flow tools reports LibreLane and the PDK missing under the Nix launcher, though runs workOpen
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 3/5 Half a day Newbie friendliness 74/100
All issues in Ferrite-Engineering/simcrux
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 62/100
ccch1mneyyy/dsh-Go#1682 ·
Maintainers usually reply within 1 day
-
help wanted
Difficulty 1/5 Under an hour Newbie friendliness 76/100
pesaclarity/ujumbe-parsers#64 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
patarapolw/lingua_srs#278 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
dreautall/waterfly-iii#890 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day