Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[feedback] help, --help, or usage in cli

Open
  • Is something wrong?
#295 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
58/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
cli

Research direction

Start at the CLI entry point that handles usabl check and argument parsing; the report shows that --help, help, and no arguments currently trigger the approval gate. Read the CLI command tests first and identify how help output is expected to bypass checks. Done means users can discover how to run a report from the CLI without opening the docs.

Written by the indexing model from the issue text.

Description

area: cli enhancement
Surface

cli

Verdict seen

Needed help getting started

Expected verdict

A bit more contextual help for how to use the CLI, without having to go look for docs

Repro

Hey, I found the CLI a bit tricky to get started with. I'm just trying to get a report of issues against the project, I don't want it to PR anything yet. It should be great if more usage or contextual help was available on the CLI;

user@host: npx usabl check
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
user@host: npx usabl check --help
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
user@host: npx usabl check help
unknown command: help
user@host: npx usabl help
unknown command: help
user@host: npx usabl
usabl: ■ APPROVAL REQUIRED (exit 2)
  This change edits guarded policy files. It needs approval on the pull request.
  gate summary: approval required: 2 guarded path(s) changed
  guarded paths changed: usabl.config.json, usabl.routes.json
  accessibility exit code: 0
Honest or confusing?

No response

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
2h 48m
Merged PRs (30d)
8

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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.

More from usabl-dev/usabl

All issues in usabl-dev/usabl

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.