feat(cli): improve help discoverability for subcommands#1
Merged
Conversation
Show inherited global flags in nested help output via Commander configuration. Add targeted issues/branch examples including JSON extraction path guidance. Update README command syntax and help-discovery examples.
There was a problem hiding this comment.
Pull request overview
Improves CLI help discoverability by making global flags visible on nested subcommand help and by adding more targeted, task-oriented help examples (including JSON extraction hints) across the CLI and README.
Changes:
- Enable inherited global options display in subcommand help (
showGlobalOptions: true). - Add command-specific “Examples” help text for
issuesandissues branch, including a JSON path hint for branch name extraction. - Update help-related tests and refresh README command-discovery / run-syntax guidance.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/cli/src/index.ts | Enables global options in subcommand help and attaches new help text to issues / issues branch. |
| packages/cli/src/help/root-help.ts | Expands root help examples and adds new issues / issues branch help text blocks (with .data.branchName hint). |
| packages/cli/tests/help.test.ts | Adds assertions verifying rendered nested help includes global options and the branch JSON path hint. |
| README.md | Refreshes CLI run/help discovery examples and updates branch examples to include --json + JSON path note. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-actions bot
pushed a commit
that referenced
this pull request
Mar 20, 2026
# [1.5.0-alpha.1](v1.4.0...v1.5.0-alpha.1) (2026-03-20) ### Features * **cli:** improve help discoverability for subcommands ([#1](#1)) ([702ebce](702ebce))
|
🎉 This PR is included in version 1.5.0-alpha.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Global Options) so--jsonis visible on subcommand help pageslinear issuesandlinear issues branch.data.branchName) to branch helpValidation
pnpm verifypnpm --filter @wiseiodev/linear-cli test