產生（generate）

擴展您的 Turborepo，添加新的應用程式和套件。

終端機

turbo generate

• turbo generate run [generator-name]：運行您在存放庫中定義的自訂產生器。
• turbo generate workspace [options]：透過複製現有的或從頭開始，在您的存放庫中建立新的套件。

有關編寫自訂產生器的更多資訊和實際用例，請參閱「生成程式碼」指南。

注意：turbo gen 是 turbo generate 的別名。此外，run 是預設命令，因此 turbo gen 等同於 turbo generate run。

run [generator-name]

運行您在存放庫中定義的自訂產生器。

終端機

turbo gen run [generator-name]

標誌選項

• --args：直接傳遞給產生器提示的答案。
• --config <path>：產生器的設定檔案。
  • 預設值：turbo/generators/config.js
• --root <path>：您的存放庫的根目錄。
  • 預設值：包含根目錄 turbo.json 的目錄。

workspace

建立新的工作區。

終端機

turbo gen workspace [options]

標誌選項

• --name <name>：新工作區在 package.json 中 name 欄位使用的名稱，作為存放庫中套件的唯一識別符。
• --empty：建立一個空的工作區。預設為 true。
• --copy <name>/<url>：您 monorepo 中本地工作區的名稱，或包含任何分支和/或子目錄的完整 GitHub URL。
• --destination <path>：新工作區應該建立的位置。
• --type <app/package>：要建立的工作區類型（應用程式或套件）。
• --root <path>：您的存放庫的根目錄。預設為包含根目錄 turbo.json 的目錄。
• --show-all-dependencies：在選擇要添加的依賴項時，防止按工作區類型過濾依賴項。
• --example-path <path>, -p <path>：在罕見的情況下，您的 GitHub URL 可能包含帶有斜線的分支名稱（例如 bug/fix-1）和範例的路徑（例如 foo/bar）。在這種情況下，您必須單獨指定範例的路徑。

scan

使用一個互動式命令，為您的 Turborepo 本地啟用更快的工具。

這將引導您完成一系列步驟，以啟用 Turborepo 的最快設定。這些優化包括：

• Git FS Monitor：turbo 依賴 Git 進行檔案變更檢測。透過使用 Git 的內建檔案系統監視器，可以更快地獲取變更通知。
• Turbo Daemon：Turborepo 的守護程式在背景中預測性地理解您的存放庫。透過提前完成 turbo 在運行任務時需要的共同工作，turbo 將更快地運行您的任務。
• 遠端快取：Turborepo 可以在本地快取您的工作，也可以在所有機器之間共享快取。啟用遠端快取使您的快取成為多人遊戲，確保您、您的團隊和您的 CI 機器不會重複相同的工作。
• 檢查 turbo 版本：我們一直在努力改進 turbo。為確保您使用最新版本的 Turborepo，我們將檢查您的版本，並在您未使用最新版本時提醒您安裝。
• 檢查 Turborepo LSP：訪問 VSCode 擴充功能市場，為您的 IDE 安裝 Turborepo LSP 擴充功能。

login

登入到您的遠端快取提供商。

預設提供商是 Vercel。要指定不同的提供商，請使用 --api 選項。

標誌選項

• --api <url>：設定遠端快取提供商的 API URL。

  終端機

  turbo login --api=https://acme.com/api
  

• --login <url>：設定登入請求的 URL。僅對具有完整登入功能的平台需要。

  終端機

  turbo login --login=https://acme.com
  

• --sso-team <team>：透過提供您的團隊縮寫，連接到啟用 SSO 的團隊。

  終端機

  turbo login --sso-team=team-slug
  

logout

登出與您的遠端快取提供商關聯的帳戶。

link

將存放庫連接到遠端快取提供商。

unlink

斷開存放庫與遠端快取的連接。

bin

獲取 turbo 二進位檔案的路徑。

• 全域 turbo：將返回全域 turbo 二進位檔案的路徑，通常是您用於安裝 turbo 的套件管理器的全域目錄。
• 本地 turbo：將返回本地 turbo 二進位檔案的路徑，通常是指向 node_modules 的路徑。

標誌選項

• --api <url>：指定遠端快取提供商的 URL。

  終端機

  turbo link --api https://acme.com
  

telemetry

turbo telemetry [argument]

管理此機器的遙測。

了解更多關於 Turborepo 的遙測 資訊。

參數

• status：檢索此機器的遙測當前狀態。

  終端機

  turbo telemetry status
  

• enable：啟用此機器的遙測。

  終端機

  turbo telemetry enable
  

• disable：停用此機器的遙測。

  終端機

  turbo telemetry disable
  

重點整理

• 產生新項目：使用 turbo generate 擴展您的 Turborepo，添加新的應用程式和套件。
• 運行自訂產生器：turbo gen run [generator-name]，可運行您定義的自訂產生器。
• 建立新工作區：turbo gen workspace [options]，可建立新的工作區，支持多種選項配置。
• 優化工具：使用 turbo scan 啟用更快的工具，如 Git FS Monitor、Turbo Daemon 和遠端快取。
• 登入與連接：使用 turbo login 登入遠端快取提供商，使用 turbo link 將存放庫連接到遠端快取。
• 遙測管理：使用 turbo telemetry 管理遙測功能，包括查看狀態、啟用和停用。

程式碼範例

運行自訂產生器

turbo gen run my-generator

建立新的工作區

turbo gen workspace --name my-package --type package

啟用優化工具

turbo scan

登入遠端快取提供商

turbo login --api=https://acme.com/api

連接存放庫到遠端快取

turbo link --api https://acme.com

查看遙測狀態

turbo telemetry status

啟用遙測

turbo telemetry enable

停用遙測

turbo telemetry disable

透過以上命令和選項，您可以有效地管理和優化您的 Turborepo 開發流程。