在 Cloud Shell 開啟

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

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

網址參數

您可以將「在 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 中開啟存放區所需的參數。