#CLI

Rsbuild includes a lightweight CLI with commands like rsbuild dev and rsbuild build.

#All commands

To view all available CLI commands, run this command in your project directory:

npx rsbuild -h

The output is shown below:

Usage:
  $ rsbuild <command> [options]

Commands:
  dev      Start the dev server
  build    Build the app for production
  preview  Preview the production build locally
  inspect  Inspect the Rspack and Rsbuild configurations

#Common flags

The Rsbuild CLI includes several common flags that work with all commands:

#rsbuild dev

The rsbuild dev command starts a local dev server and compiles source code for development.

Usage: rsbuild dev [options]

Options:
  -o, --open [url]      Open the page in browser on startup
  --port <port>         Set the port number for the server
  --host <host>         Set the host that the server listens to

Start the dev server by running rsbuild directly, which is equivalent to rsbuild dev:

npx rsbuild

#Opening page

The --open option automatically opens a page when starting the dev server, equivalent to setting server.open to true.

rsbuild dev --open

The --open option also supports specifying a URL to open, for example:

rsbuild dev --open http://localhost:3000/foo

The --open option can also be abbreviated to -o:

rsbuild dev -o

#rsbuild build

The rsbuild build command builds production outputs in the dist/ directory by default.

Usage: rsbuild build [options]

Options:
  -w, --watch           Enable watch mode to automatically rebuild on file changes

#rsbuild preview

The rsbuild preview command previews production build outputs locally. Run rsbuild build first to generate the build outputs.

Usage: rsbuild preview [options]

Options:
  -o, --open [url]      Open the page in browser on startup
  --port <port>         Set a port number for Rsbuild server to listen
  --host <host>         Set the host that the Rsbuild server listens to

#rsbuild inspect

The rsbuild inspect command displays the project's Rsbuild and Rspack configurations.

Usage: rsbuild inspect [options]

Options:
  --output <output>     Set the output path for inspection results (default: ".rsbuild")
  --verbose             Show complete function definitions in output

Running npx rsbuild inspect in the project root generates these files in the dist/.rsbuild directory:

• rsbuild.config.mjs: Represents the Rsbuild configuration used during the build.
• rspack.config.web.mjs: Represents the Rspack configuration used during the build.

➜ npx rsbuild inspect

config inspection completed, generated files:

  - Rsbuild config: /project/dist/.rsbuild/rsbuild.config.mjs
  - Rspack config (web): /project/dist/.rsbuild/rspack.config.web.mjs

#Setting mode

By default, the inspect command outputs the configuration for the development mode. You can add the --mode production option to output the configuration for the production mode:

rsbuild inspect --mode production

#Verbose content

By default, the inspect command omits the content of functions in the configuration object. You can add the --verbose option to output the complete content of functions:

rsbuild inspect --verbose

#Multiple targets

If the current project has multiple build targets, such as building browser bundles and Node.js bundles simultaneously, multiple Rspack configuration files will be generated in the dist/.rsbuild directory.

➜ npx rsbuild inspect

config inspection completed, generated files:

  - Rsbuild config (web): /project/dist/.rsbuild/rsbuild.config.web.mjs
  - Rsbuild config (node): /project/dist/.rsbuild/rsbuild.config.node.mjs
  - Rspack config (web): /project/dist/.rsbuild/rspack.config.web.mjs
  - Rspack config (node): /project/dist/.rsbuild/rspack.config.node.mjs