fix(cli): improve command usage display#6506
Merged
chenjiahan merged 2 commits intomainfrom Nov 5, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the CLI usage message to clarify that both command and options are optional parameters by changing the angle brackets (<>) to square brackets ([]). This better represents the actual CLI behavior where commands are optional (defaulting to the dev command).
- Updated the usage documentation in both English and Chinese documentation files to reflect optional command syntax
- Modified the CLI help output formatting logic to explicitly set the usage line with correct bracket notation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/zh/guide/basic/cli.mdx | Updated Chinese documentation to show command as optional parameter |
| website/docs/en/guide/basic/cli.mdx | Updated English documentation to show command as optional parameter |
| packages/core/src/cli/commands.ts | Added logic to format the Usage section with correct optional parameter syntax |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
The usage section now shows the command format in green for better visibility.
Before
After
Checklist