在 Cloud Shell 開啟

您可以使用「Open in Cloud Shell」(在 Cloud Shell 中開啟) 功能發布連結,開啟 Google Cloud 控制台並將 Git 存放區複製到 Cloud Shell,或使用自訂映像檔啟動 Cloud Shell。您也可以在終端機中列印操作說明,協助使用者與內容互動。

「在 Cloud Shell 中開啟」連結可協助開發人員試用程式碼範例和 API,不必下載 Google Cloud CLI、安裝必要依附元件或搜尋相關來源檔案。本頁面說明如何在 Git 存放區中新增「Open in 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 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 中開啟) 連結的行為,您可以使用下方的表單,試驗在 Cloud Shell 中開啟存放區所需的參數。