Skip to content

Commit 1d5a72e

Browse files
committed
fix: update command descriptions
1 parent 273be27 commit 1d5a72e

2 files changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Rstack CLI brings the Rstack toolchain together for JavaScript development, with
1212

1313
It also covers local development needs outside Rstack's scope, with Oxfmt formatting and lint-staged commands.
1414

15-
| Command | Description | Powered by |
16-
| ------------ | ----------------------------- | --------------------------------------------------------- |
17-
| `rs dev` | Start a local app dev server | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
18-
| `rs build` | Create a production app build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
19-
| `rs preview` | Preview the production build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
20-
| `rs test` | Run the test suite | [Rstest](https://github.com/web-infra-dev/rstest) |
21-
| `rs lint` | Lint and type-check code | [Rslint](https://github.com/web-infra-dev/rslint) |
22-
| `rs lib` | Build library outputs | [Rslib](https://github.com/web-infra-dev/rslib) |
23-
| `rs doc` | Develop and build docs (TODO) | [Rspress](https://github.com/web-infra-dev/rspress) |
24-
| `rs fmt` | Format code (TODO) | [Oxfmt](https://github.com/oxc-project/oxc) |
25-
| `rs setup` | Setup git hooks (TODO) | - |
26-
| `rs staged` | Run tasks for staged files | [lint-staged](https://github.com/lint-staged/lint-staged) |
15+
| Command | Description | Powered by |
16+
| ------------ | -------------------------------- | --------------------------------------------------------- |
17+
| `rs dev` | Run the app dev server | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
18+
| `rs build` | Build the app for production | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
19+
| `rs preview` | Preview the app production build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) |
20+
| `rs test` | Run tests | [Rstest](https://github.com/web-infra-dev/rstest) |
21+
| `rs lint` | Lint code | [Rslint](https://github.com/web-infra-dev/rslint) |
22+
| `rs lib` | Build library | [Rslib](https://github.com/web-infra-dev/rslib) |
23+
| `rs doc` | Serve or build docs | [Rspress](https://github.com/web-infra-dev/rspress) |
24+
| `rs fmt` | Format code (TODO) | [Oxfmt](https://github.com/oxc-project/oxc) |
25+
| `rs setup` | Set up Git hooks (TODO) | - |
26+
| `rs staged` | Run tasks on staged Git files | [lint-staged](https://github.com/lint-staged/lint-staged) |
2727

2828
Rstack CLI fits into your existing project workflow. It does not replace your runtime, package manager, or task runner, such as [pnpm](https://github.com/pnpm/pnpm), [Bun](https://github.com/oven-sh/bun), [Turborepo](https://github.com/vercel/turborepo), [Nx](https://github.com/nrwl/nx), and [Nub](https://github.com/nubjs/nub).
2929

packages/rstack/src/cli/commands.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Usage:
1313
$ rs [command] [...options]
1414
1515
Commands:
16-
dev Start the app dev server
16+
dev Run the app dev server
1717
build Build the app for production
18-
preview Preview the app production build locally
19-
lib Build library outputs
20-
doc Develop and build docs
21-
lint Run lint checks
18+
preview Preview the app production build
19+
lib Build library
20+
doc Serve or build docs
21+
lint Lint code
2222
test Run tests
23-
staged Run configured tasks on staged Git files
23+
staged Run tasks on staged Git files
2424
2525
For command-specific options, run:
2626
$ rs <command> -h

0 commit comments

Comments
 (0)