借助在 Cloud Shell 中打开功能，您可以发布一个链接，该链接可打开 Google Cloud 控制台，并将 Git 代码库克隆到 Cloud Shell 中，或者使用自定义映像启动 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）和路径。允许使用以下字符：大写和小写字母、数字、下划线 (_)、连字符 (-)、英文句点 (.) 和正斜杠 (/)。 只有 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_open_in_editor
|
要在 Cloud Shell Editor 中打开的文件。可以重复使用此参数以指定多个要打开的文件。如果指定了多个，则会按提供的顺序打开。 指定的文件将在已打开项目右侧的编辑器标签中打开，每个文件一个标签。 文件路径相对于当前目录。如果提供了 working_dir 参数，则这些文件的路径将被视为相对于 working_dir。 |
包含以下有效字符的任何有效文件路径：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/)和英文冒号 (:)。 |
cloudshell_print
|
Git 代码库中的文件，通常包括要打印到终端的说明，用于指导用户接下来的操作。文件路径相对于当前目录。 如果提供了 working_dir 参数，则这些文件的路径将被视为相对于 working_dir。 |
包含以下有效字符的任何有效文件路径：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/)和英文冒号 (:)。 |
cloudshell_tutorial
|
Git 代码库中的教程 Markdown 文件，包括要作为教程启动的说明，用于指导用户完成项目。文件路径相对于当前目录。 |
具有有效的文件名且格式标准的任何教程 Markdown 文件。 |
cloudshell_working_dir （已废弃）
|
此参数已被弃用。请改用 |
由以下允许的字符组成的任何有效文件路径：大写和小写字母、数字、波浪号 (~)、下划线 (_)、连字符 (-)、英文句点 (.)、正斜杠 (/) 和冒号 (:)。 |
cloudshell_workspace
|
Cloud Shell 的工作目录。终端会在指定的目录中打开。Cloud Shell Editor 将目录作为工作区打开。 | 相对于克隆代码库的任何有效文件路径。您可以将参数值留空，或使用 . 指定克隆代码库的根目录。如果未指定代码库，则路径是 Cloud Shell 主目录的相对路径。允许使用以下字符：大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、英文句点 (.)、正斜杠 (/) 和冒号 (:)。 |
ephemeral |
在指定此参数的情况下在 Cloud Shell 中打开代码库会创建一个临时环境，其中包含一个在会话结束时删除的临时主目录。如需了解详情，请参阅选择暂存模式。 | true，false |
show
|
仅使用终端、仅使用 Cloud Shell 编辑器或同时使用两者打开。 |
ide、terminal、ide%2Cterminal |
示例
如需嵌入一个按钮以在 Cloud Shell 中打开示例 Git 代码库，请在代码库的 README.md 文件中添加以下 Markdown：
[](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 中打开代码库所需的参数。