@rspack/cli is the command line tool for Rspack, providing a variety of commands to make working with Rspack easier.
@rspack/cli
installed, please read the Quick start section first.@rspack/cli
is not compatible with webpack-cli
, so there will be some differences between the two.
To view all available CLI commands, run the following command in the project directory:
Rspack CLI provides several common flags that can be used with all commands:
Flag | Description |
---|---|
-c, --config [value] | Specify the path to the configuration file, see Specify the configuration file |
--configLoader | Specify the loader to load the config file, can be native or register , defaults to register |
--configName | Specify the name of the configuration to use. |
-h, --help | Show help information |
-v, --version | Show version number |
All flags in Rspack CLI support the camelCase
and kebab-case
, for example, both --configLoader
and --config-loader
are valid.
rspack build
is used to run Rspack build, which will generate the output files in the output.path directory.
rspack build
can be abbreviated as rspack b
:
Use the -c
or --config
flag to specify the configuration file path:
The complete flags are as follows:
rspack dev
is used to run Rspack dev server, which will start a local dev server that will listen for file changes and automatically refresh the browser.
Use the -c
or --config
flag to specify the configuration file path:
rspack dev
can be abbreviated as rspack serve
or rspack s
:
The complete flags are as follows:
rspack preview
is used to preview the production build output locally, note that you need to build the output first by running the rspack build
command.
The complete flags are as follows: