Rsbuild comes with a lightweight CLI that includes commands such as rsbuild dev and rsbuild build.
To view all available CLI commands, run the following command in the project directory:
The output is shown below:
Rsbuild CLI provides several common flags that can be used with all commands:
Flag | Description |
---|---|
--base <base> |
Specify the base path of the server, see server.base |
-c, --config <config> |
Specify the configuration file, can be a relative or absolute path, see Specify config file |
--config-loader <loader> |
Specify the config loader, can be jiti or native , see Specify config loader |
--env-mode <mode> |
Specify the env mode to load the .env.[mode] file, see Env mode |
--env-dir <dir> |
Specify the directory to load .env files, see Env directory |
--environment <name> |
Specify the name of environment to build, see Build specified environment |
-h, --help |
Display help for command |
-m, --mode <mode> |
Specify the build mode (development , production or none ), see mode |
-r, --root <root> |
Specify the project root directory |
The rsbuild dev
command is used to start a local dev server and compile the source code for development.
The --open
option allows you to automatically open a page when starting the dev server, which is equivalent to setting server.open to true
.
The --open
option also supports specifying the URL to be opened, for example:
The --open
option can also be abbreviated to -o
:
When using server.open and --open
at the same time, --open
takes precedence.
The rsbuild build
command will build the outputs for production in the dist/
directory by default.
The rsbuild preview
command is used to preview the production build outputs locally. Note that you need to execute the rsbuild build
command beforehand to generate the build outputs.
The preview command is only used for local preview. Do not use it for production servers, as it is not designed for that.
The rsbuild inspect
command is used to view the Rsbuild config and Rspack config of the project.
When you run the command npx rsbuild inspect
in the project root directory, the following files will be generated in the dist/.rsbuild
directory of the project:
rsbuild.config.mjs
: Represents the Rsbuild configuration used during the build.rspack.config.web.mjs
: Represents the Rspack configuration used during the build.By default, the inspect command outputs the configuration for the development mode. You can add the --env production
option to output the configuration for the production mode:
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:
If the current project has multiple build targets, such as building browser artifact and Node.js artifact simultaneously, multiple Rspack configuration files will be generated in the dist/.rsbuild
directory.