快速上手#

环境准备#

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

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

node -v

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

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

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

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

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

创建 Rsbuild 项目#

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

npm create rsbuild@latest

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

从现有项目迁移#

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

• 从 Webpack 迁移
• 从 Create React App 迁移
• 从 Vue CLI 迁移
• 从 Modern.js Builder 迁移

其他项目#

对于其他类型的项目，你可以手动安装 @rsbuild/core 包：

npm add @rsbuild/core -D

然后参考指南和文档，按需启用各个功能：

• 参考 CLI 工具 来了解可用的 CLI 命令。
• 参考 插件列表 来选择 Rsbuild 插件。
• 参考 配置 Rsbuild 进行配置。

命令行工具#

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

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

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

入口模块#

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

下一步#

你可能想要：