在 Cloud Shell 中打开

借助“在 Cloud Shell 中打开”功能，您可以发布一个链接，以便使用克隆到 Cloud Shell 中的 Git 代码库打开 Google Cloud 控制台，并/或使用自定义映像启动 Cloud Shell。您还可以将说明输出到终端，以帮助用户与内容进行交互。

“在 Cloud Shell 中打开”链接可帮助开发者试验您的代码示例和 API，而无需下载 Google Cloud CLI、安装所需的依赖项或搜索相关源文件。本页面介绍了如何向 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）和路径。允许使用以下字符：大写和小写字母、数字、下划线 (_)、连字符 (-)、英文句点 (.) 和正斜杠 (/)。

cloudshell_git_repo

要克隆的 Git 代码库的网址。

克隆代码库后，系统会打开项目文件夹的根目录，并在左侧导航窗格中显示其内容。

Git 代码库的有效网址。

此网址包含允许的网域（GitHub 或 Bitbucket）和路径。允许使用以下字符：大写和小写字母、数字、下划线 (_)、连字符 (-)、英文句点 (.) 和正斜杠 (/)。

可选网址参数

您还可以指定以下任何可选参数：

网址参数	说明	支持的值
`cloudshell_git_branch`	要从 Git 代码库中克隆的分支。仅在指定“cloudshell_git_repo”cloudshell_git_repo时适用。默认分支是 master。	代码库中的任何有效分支。允许使用以下字符：大写字母、小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/) 和冒号 (:)。
`cloudshell_image`	可在会话期间运行自定义环境的自定义 Docker 映像。这样，您就可以在 Cloud Shell 中提供自定义工具，供用户用来与您的代码库搭配使用。使用此参数在 Cloud Shell 中打开代码库会创建一个包含临时主目录的临时环境，会话结束时该目录会被删除。	Container Registry 中托管的 Docker 映像的网址。Docker 映像必须基于 Cloud Shell 基础映像，并且可以公开访问。如需创建有效的映像，请在 Cloud Shell 中运行以下命令来使用自定义映像创建教程： `cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md` 另请注意，打开网址时，大映像需要一段时间才��下载到 Cloud Shell ��拟机中。
`cloudshell_open_in_editor`	要在 Cloud Shell Editor 中打开的文件。可以重复使用此参数以指定多个要打开的文件。如果指定了多个文件，它们将按照提供的顺序打开。指定的文件将在已打开项目右侧的编辑器标签中打开，每个文件一个标签。文件路径相对于当前目录。如果提供了 working_dir 参数，则这些文件的路径将被视为相对于 working_dir。working_dirworking_dir	包含以下有效字符的任何有效文件路径：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/)和英文冒号 (:)。
`cloudshell_print`	Git 代码库中的文件，通常包括要打印到终端的说明，用于指导用户接下来的操作。文件路径相对于当前目录。如果提供了 working_dir 参数，则这些文件的路径将被视为相对于 working_dir。working_dirworking_dir	包含以下有效字符的任何有效文件路径：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/)和英文冒号 (:)。
`cloudshell_tutorial`	Git 代码库中的教程 Markdown 文件，包括要作为教程启动的说明，用于指导用户完成项目。文件路径相对于当前目录。	具有有效的文件名且格式标准的任何教程 Markdown 文件。
`cloudshell_working_dir` （已弃用）	此参数已被弃用。请改用 `cloudshell_workspace`。	包含以下允许使用的字符的任何有效文件路径：大写和小写字母、数字、波浪线 (~)、下划线 (_)、连字符 (-)、英文句点 (.)、正斜杠 (/) 和冒号 (:)。
`cloudshell_workspace`	Cloud Shell 的工作目录。终端会在指定的目录中打开。Cloud Shell Editor 将目录作为工作区打开。	相对于克隆代码库的任何有效文件路径。您可以将参数值留空，或使用 `.` 指定克隆代码库的根目录。如果未指定代码库，则路径是 Cloud Shell 主目录的相对路径。允许使用以下字符：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、英文句点 (.)、正斜杠 (/) 和冒号 (:)。
`ephemeral`	使用此参数在 Cloud Shell 中打开代码库会创建一个包含临时主目录的临时环境，会话结束时该目录会被删除。如需了解详情，请参阅选择暂存模式。	`true`，`false`
`show`	仅使用终端和/或 Cloud Shell Editor 打开。	`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>

“在 Cloud Shell 中打开”链接生成器

如需更具体地定义“在 Cloud Shell 中打开”链接的行为，您可以使用以下表单对在 Cloud Shell 中打开代码库所需的参数进行实验。