#Quick start

Get up to speed quickly with a new Rspack based project.

• Create a new project: Use the CLI to create a brand-new Rspack or Rsbuild project.
• Migrating from existing projects: Migrate from a webpack-based project to Rspack.

#Ecosystem

As a low-level bundler, Rspack has a rich ecosystem that includes various frameworks, tools, and solutions. These ecosystem projects cover different aspects from frameworks to development tools, meeting diverse development needs across scenarios and providing an out-of-the-box experience.

See the Ecosystem page to explore these ecosystem projects.

#Environment preparation

Rspack supports using Node.js, Deno, or Bun as the JavaScript runtime.

You can refer to the following installation guides and choose one runtime:

• Install Node.js
• Install Bun
• Install Deno

#Create a new project

#Using Rsbuild

We recommend using Rsbuild to create new projects. Rsbuild is a build tool powered by Rspack, with built-in build configuration, a dev server, and integrations for frameworks such as React and Vue to help you get started quickly.

Run the following command and follow the prompts:

npm create rsbuild@latest

yarn create rsbuild

pnpm create rsbuild@latest

bun create rsbuild@latest

deno init --npm rsbuild@latest

See Rsbuild - Quick start to learn more.

#Using Rspack CLI

Rspack CLI provides a command-line interface for using Rspack directly. You configure loaders, plugins, and other build capabilities yourself, making it suitable for projects that need a custom build workflow based on low-level configuration.

Run the following command and follow the prompts:

npm create rspack@latest

yarn create rspack

pnpm create rspack@latest

bun create rspack@latest

deno init --npm rspack@latest

#Non-interactive mode

create-rspack and create-rsbuild support a non-interactive mode through command-line options. This mode lets you skip all prompts and create a project directly, which is useful for scripts, CI, and coding agents.

For example, the following command creates a React app in the my-app directory:

# Rspack CLI
npx -y create-rspack --dir my-app --template react

# Rsbuild
npx -y create-rsbuild --dir my-app --template react

# Using abbreviations
npx -y create-rsbuild -d my-app -t react

#Manual installation

Start by creating a project directory and generating an npm `package.json':

mkdir rspack-demo
cd rspack-demo
npm init -y

Then installing @rspack/core and @rspack/cli as dev dependencies:

npm add @rspack/core @rspack/cli -D

yarn add @rspack/core @rspack/cli -D

pnpm add @rspack/core @rspack/cli -D

bun add @rspack/core @rspack/cli -D

deno add npm:@rspack/core npm:@rspack/cli -D

Update your build scripts to use Rspack CLI:

{
  "scripts": {
    "dev": "rspack dev",
    "build": "rspack build",
    "preview": "rspack preview"
  }
}

Next, see Configure Rspack to learn about how to configure Rspack.

#Migrating from existing projects

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

• Migrating from webpack to Rspack
• Migrating from webpack to Rsbuild
• Migrating from Create React App to Rsbuild
• Migrating from Vue CLI to Rsbuild
• Migrating from Vite to Rsbuild
• Migrating from Tsup to Rslib
• Migrating from Storybook

#Install canary version

When you need to test or verify the features of Rspack that are not yet released to the stable version, you may need to use the canary version.

The canary version of Rspack has a -canary suffix in the package scope. For example, the canary package name of @rspack/core is @rspack-canary/core. To use these versions, you can configure the overrides of the package manager (npm/yarn/pnpm/bun).

Here is an example of using pnpm overrides:

{
  "pnpm": {
    "overrides": {
      "@rspack/core": "npm:@rspack-canary/core@latest"
    },
    "peerDependencyRules": {
      "allowAny": ["@rspack/*"]
    }
  }
}

Rspack community also provides install-rspack tool to easily install canary version:

npx install-rspack --version latest # Install the latest version
npx install-rspack --version canary # Install the canary version
npx install-rspack --version 1.0.0-canary-d614005-20250101082730 # Install the specified canary version