Quick Start#

Setup Environment#

Before getting started, you will need to install Node.js, and ensure that your Node.js version is not lower than 16. We recommend using the LTS version of Node.js 18.

You can check the currently used Node.js version with the following command:

node -v

If you do not have Node.js installed in your current environment, or the installed version is lower than 16, you can use nvm or fnm to install the required version.

Here is an example of how to install the Node.js 18 LTS version via nvm:

# Install the long-term support version of Node.js 18
nvm install 18 --lts

# Make the newly installed Node.js 18 as the default version
nvm alias default 18

# Switch to the newly installed Node.js 18
nvm use 18

Creating an Rsbuild Project#

You can use the create-rsbuild to create a new Rsbuild project. Just execute the following command:

npm create rsbuild@latest

Then follow the prompts to complete the operation. You can choose from the following templates provided by create-rsbuild:

Migrate from Existing Projects#

If you need to migrate from an existing project to Rsbuild, you can refer to the following guides:

• Migrate from Webpack
• Migrate from Create React App
• Migrate from Vue CLI
• Migrate from Modern.js Builder

Command Line Interface#

Rsbuild comes with a lightweight CLI that includes commands such as dev and build.

{
  "scripts": {
    // starting the dev server
    "dev": "rsbuild dev",
    // build the app for production
    "build": "rsbuild build",
    // preview the production build locally
    "preview": "rsbuild preview"
  }
}

Refer to the CLI Tool to learn about all available commands and options.

Entry Module#

By default, Rsbuild CLI uses src/index.(js|ts|jsx|tsx) as the entry module. You can modify the entry module using the source.entry option.

Next Step#

You may want: