快速上手

环境准备

在开始使用前，你需要安装 Node.js，并保证 Node.js 版本不低于 16，我们推荐使用 Node.js 18 的 LTS 版本。

你可以通过以下命令检查当前使用的 Node.js 版本：

node -v

如果你当前的环境中尚未安装 Node.js，或是安装的版本低于 16，可以通过 nvm 或 fnm 安装需要的版本。

下面是通过 nvm 安装 Node.js 18 LTS 版本的例子：

# 安装 Node.js 18 的长期支持版本
nvm install 18 --lts

# 将刚安装的 Node.js 18 设置为默认版本
nvm alias default 18

# 切换到刚安装的 Node.js 18
nvm use 18

nvm 和 fnm

nvm 和 fnm 都是 Node.js 版本管理工具。相对来说，nvm 较为成熟和稳定，而 fnm 是使用 Rust 实现的，比 nvm 提供了更好的性能。

创建 Rsbuild 项目

你可以使用 create-rsbuild 来创建一个 Rsbuild 项目，调用以下命令：

npm

yarn

pnpm

bun

npm create rsbuild@latest

然后按照提示操作即可，你可以选择 create-rsbuild 提供的下列模板：

模板	描述	可选功能
react	React 18	TypeScript
vue3	Vue 3	TypeScript
vue2	Vue 2	TypeScript
lit	Lit	TypeScript
preact	Preact	TypeScript
svelte	Svelte	TypeScript
solid	Solid	TypeScript
vanilla	原生 JavaScript	TypeScript

从现有项目迁移

如果你需要从一个现有项目迁移迁移到 Rsbuild，可以参考以下指南：

命令行工具

Rsbuild 内置了一个轻量的命令行工具，包含 dev、build 等命令。

package.json

{
  "scripts": {
    // 启动开发服务器
    "dev": "rsbuild dev",
    // 构建用于生产的应用
    "build": "rsbuild build",
    // 在本地预览生产版本
    "preview": "rsbuild preview"
  }
}

请参考 CLI 工具来了解所有可用的命令以及选项。

入口模块

Rsbuild CLI 默认会使用 src/index.(js|ts|jsx|tsx) 作为入口模块，你可以使用 source.entry 配置项来修改入口模块。

下一步

你可能想要：

功能导航

了解 Rsbuild 提供的所有功能

查阅配置

了解如何配置 Rsbuild

名词解释

了解 Rsbuild 相关的概念

快速上手#

环境准备#

创建 Rsbuild 项目#

从现有项目迁移#

命令行工具#

入口模块#