安装

使用以下工具,快速开始使用 Turborepo

终端
pnpm dlx create-turbo@latest

这个启动仓库将包含

  • 两个可部署的应用
  • 三个可在 monorepo 中其他部分使用的共享库

有关 starter 的更多详细信息,请访问 GitHub 上 basic starter 的 README。 你也可以使用一个更符合你的工具兴趣的示例

安装 turbo

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

全局安装

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

终端
pnpm install turbo --global

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

  • turbo build:按照你的仓库依赖关系图运行 build 脚本
  • turbo build --filter=docs --dry:快速打印 docs 包的 build 任务的概要(不运行它)
  • turbo generate:运行 Generators 以向你的仓库添加新代码
  • cd apps/docs && turbo build:在 docs 包及其依赖项中运行 build 脚本。 更多信息,请访问 自动包作用域部分

须知: 

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

避免多次全局安装

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

在 CI 中使用全局 turbo

在创建 CI 管道时,你也可以利用全局 turbo。 有关更多信息,请访问 构建 CI 指南。

仓库安装

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

终端
pnpm add turbo --save-dev --ignore-workspace-root-check

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

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