快速开始

安装

使用 create-turbo 在几分钟内开始使用 Turborepo。

使用以下命令在几分钟内开始使用 Turborepo:

pnpm dlx create-turbo@latest

启动仓库将包含:

  • 两个可部署的应用程序
  • 三个供 monorepo 其余部分使用的共享库

有关启动器的更多详细信息,请访问 GitHub 上基础启动器的 README。您也可以使用示例,这些示例更符合您的工具兴趣。

安装 turbo

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

全局安装

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

pnpm add turbo --global

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

  • turbo build:按照您仓库的依赖图运行 build 脚本
  • turbo build --filter=docs --dry:快速打印 docs 包的 build 任务大纲(不运行它)
  • turbo generate:运行生成器向您的仓库添加新代码
  • 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 会优先使用仓库的本地版本。

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