安装

只需几分钟就能开始使用 Turborepo:

Terminal
npx create-turbo@latest

启动仓库将包含:

  • 两个可部署的应用程序
  • 三个在整个 monorepo 中共享的库

要了解有关启动器的更多详细信息,请访问 GitHub 上的基础启动器 README。你还可以使用更符合你的工具需求的示例

安装 turbo

turbo 可以同时在全局你的仓库中安装。我们强烈建议同时采用这两种安装方式,这样你就可以利用快速、便捷的工作流程,同时为仓库中的所有开发者提供稳定版本的 turbo

全局安装

全局安装 turbo 为你的本地工作流程带来灵活性和速度。

Terminal
npm install turbo --global

一旦全局安装完成,你就可以从终端通过 turbo 运行你的脚本,快速执行一次性命令以在你的仓库中使用。例如:

  • turbo build:按照你仓库的依赖图运行 build 脚本
  • turbo build --filter=docs --dry:快速打印 docs 包的 build 任务大纲(无需运行)
  • turbo generate:运行生成器向你的仓库添加新代码
  • cd apps/docs && turbo build:在 docs 包及其依赖项中运行 build 脚本。更多信息请访问自动包范围部分

Good to know: 

turboturbo run 的别名。例如,turbo buildturbo run build 都会运行你的 build 任务。

避免多次全局安装

如果你之前安装过全局 turbo,请确保使用与现有安装相同的包管理器,以避免意外行为。你可以使用 turbo bin 快速检查你之前使用的包管理器。

在 CI 中使用全局 turbo

你还可以在创建 CI 流水线时利用全局 turbo。访问构建 CI 指南了解更多信息。

仓库安装

在与仓库中的其他开发者协作时,固定依赖项的版本是个好主意。你可以通过在仓库根目录将 turbo 添加为 devDependency 来实现这一点:

Terminal
npm install turbo --save-dev

你可以继续使用全局安装的 turbo 来运行命令。如果仓库存在本地版本,全局 turbo 将使用本地版本。

这让你能够同时获得两种安装方式的最佳效果:在终端中轻松运行命令,同时为仓库中的所有开发者维护一个固定版本以保持一致的使用。