在 Cloud Shell 開啟

您可以透過「在 Cloud Shell 中開啟」功能發布連結，開啟具有複製至 Cloud Shell 的 Git 存放區的 Google Cloud 控制台，以及/或是使用自訂映像檔啟動 Cloud Shell。您也可以將操作說明列印到終端機，協助使用者與內容互動。

開發人員可以透過「在 Cloud Shell 中開啟」連結，不必下載 Google Cloud CLI、安裝必要的依附元件或搜尋相關原始碼檔案，即可試驗程式碼範例和 API。本頁說明如何在 Git 存放區中新增「在 Cloud Shell 中開啟」連結。

網址參數

您可以將「在 Cloud Shell 中開啟」連結 (可視需要嵌入按鈕圖片) 新增至 Git 存放區中任何目錄的 README.md 檔案。這個連結的建議位置是 Git 存放區的根目錄 README.md 檔案。

必要的網址參數

如要建立此連結，請使用 shell.cloud.google.com 的基準網址 (或 Google Cloud 主控台中以 console.cloud.google.com 開頭的任何網頁)，並搭配下列必要網址參數：

網址參數 說明 支援的值
cloudshell_git_repo

要複製的 Git 存放區網址。

複製存放區後，系統會開啟專案資料夾的根目錄，並在左側導覽窗格中顯示其內容。

有效的 Git 存放區網址。

這個網址包含一個允許的網域 (GitHub 或 Bitbucket) 和路徑。允許使用下列字元：大寫和小寫英文字母、數字、底線 (_)、連字號 (-)、半形句號 (.) 和斜線 (/)。

只有 Google 擁有的許可清單中的存放區會在預設的 Cloud Shell 環境中開啟，並可存取使用者的憑證。所有其他存放區都會使用臨時 Cloud Shell 環境，且不會存取使用者的憑證。

選用網址參數

您也可以指定下列任一選用參數：

網址參數 說明 支援的值
cloudshell_git_branch 要複製的 Git 存放區分支。只有在指定 cloudshell_git_repo 時才適用。預設分支版本為 master。 存放區中的任何有效分支版本，允許使用以下字元：大寫和小寫英文字母、數字、波浪號 (~)、底線 (_)、連字號 (-)、句號 (.)、斜線 (/) 和冒號 (:)。
cloudshell_image

在工作階段中執行自訂環境的自訂 Docker 映像檔。這樣一來，您就能在 Cloud Shell 中提供自訂工具，讓使用者用來操作存放區。

在 Cloud Shell 中開啟存放區時指定這個參數，會建立臨時環境，其中包含會在工作階段結束時刪除的臨時主目錄。

Artifact Registry 中託管的 Docker 映像檔網址。Docker 映像檔必須以 Cloud Shell 基本映像檔為基礎，且可供公開存取。

如要建立有效的映像檔，請參閱自訂映像檔建立教學課程，您可以在 Cloud Shell 中執行下列指令來啟動教學課程：

cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md

請注意，開啟網址時，系統需要花費一些時間將大型圖片下載至 Cloud Shell VM。
cloudshell_open_in_editor

要在 Cloud Shell 編輯器中開啟的檔案。您可以重複使用這項參數來指定多個要開啟的檔案。如果指定多個，系統會依照提供的順序開啟。

在已開啟的專案中，系統會在右側的編輯器分頁中開啟指定的檔案，每個檔案一個分頁。

檔案路徑與目前的目錄有關。如果提供 working_dir 參數，這些檔案的路徑會視為相對於 working_dir。

 任何有效的檔案路徑，其內容包含下列允許的字元：大寫和小寫英文字母、數字、波浪號 (~)、底線 (_)、連字號 (-)、半形句號 (.)、正斜線 (/) 和冒號 (:)。
cloudshell_print

Git 存放區中的檔案，通常包含要顯示在使用者裝置的操作說明，以便他們瞭解後續步驟。檔案路徑與目前的目錄有關。

如果提供 working_dir 參數，系統會將此檔案的路徑視為相對於 working_dir。

 任何有效的檔案路徑，其內容包含下列允許的字元：大寫和小寫英文字母、數字、波浪號 (~)、底線 (_)、連字號 (-)、半形句號 (.)、正斜線 (/) 和冒號 (:)。
cloudshell_tutorial

Git 存放區中的教學課程 Markdown 檔案，其中包含的操作說明可做為教學課程，引導使用者完成專案。檔案路徑是相對於目前目錄的相對路徑。

任何格式正確、檔案名稱有效的教學課程 Markdown 檔案。
cloudshell_working_dir (已淘汰)

這個參數已淘汰。請改用 cloudshell_workspace。

 任何有效的檔案路徑，其內容包含下列允許的字元：大寫和小寫英文字母、數字、波浪號 (~)、底線 (_)、連字號 (-)、半形句號 (.)、正斜線 (/) 和冒號 (:)。
cloudshell_workspace Cloud Shell 的工作目錄。終端機會在指定的目錄中開啟。Cloud Shell 編輯器會將目錄開啟為工作區。 任何與已複製的存放區相關的有效檔案路徑。您可以將參數值留空，或使用 . 指定複製的存放區根目錄。如果未指定存放區，路徑會相對於 Cloud Shell 主目錄。允許使用以下字元：大寫和小寫英文字母、數字、破折號 (~)、底線 (_)、連字號 (-)、句號 (.)、斜線 (/) 和冒號 (:)。
ephemeral 在 Cloud Shell 中開啟存放區時指定這個參數，會建立臨時環境，其中包含會在工作階段結束時刪除的臨時主目錄。詳情請參閱「選擇暫時模式」。

true、false
show

開啟時只使用終端機、只使用 Cloud Shell 編輯器，或同時使用兩者。

ide、terminal、ide%2Cterminal

範例

如要嵌入按鈕，在 Cloud Shell 中開啟範例 Git 存放區，請在存放區的 README.md 檔案中加入下列 Markdown：

  [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)

如要將相同功能嵌入網站，請使用以下等效的 HTML 程式碼片段：

  <a href="https://shell.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git">
  <img alt="Open in Cloud Shell" src ="https://gstatic.com/cloudssh/images/open-btn.svg">
  </a>

如要進一步定義「Open in Cloud Shell」連結的行為，您可以使用下方表單，嘗試在 Cloud Shell 中開啟存放區所需的參數。