在 Cloud Shell 中打开

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

“在 Cloud Shell 中打开”链接可帮助开发者试用您的代码示例和 API,而无需下载 Cloud SDK、安装所需的依赖项或搜索相关源文件。本页面介绍了如何将“在 Cloud Shell 中打开”链接添加到您的 Git 代码库。

网址参数

“在 Cloud Shell 中打开”链接(可以视情况嵌入到按钮图片中)可添加到 Git 代码库中任意目录的 README.md 中。建议将此链接添加到 Git 代码库的根 README.md 文件。

必需参数

如需创建此类链接,您必须使用基准网址 ssh.cloud.google.com(或 Cloud Console 中以 console.cloud.google.com 开头的任何页面),其中至少包含以下网址参数之一:

网址参数 说明 支持的值
cloudshell_git_repo

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

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

Git 代码库的有效网址。

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

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_git_branch

要从 Git 代码库中克隆的分支。仅在指定“cloudshell_git_repo”时适用。默认分支是 master。 代码库中的任何有效分支。允许使用以下字符:大写字母、小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/) 和冒号 (:)。

cloudshell_workspace

Cloud Shell 的工作目录。终端会在指定的目录中打开。Cloud Shell Editor 将目录作为工作区打开。 相对于克隆代码库的任何有效文件路径。您可以将参数值留空,或使用“.”指定克隆代码库的根目录。如果未指定代码库,则路径是 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 文件。

shellonly

仅使用命令行(而不是编辑器)打开。

true、false

cloudshell_working_dir(已弃用)

要在 Cloud Shell Editor 中以工作区形式打开的目录 包含以下有效字符的任何有效文件路径:大写和小写字母、数字、波形符 (~)、下划线 (_)、连字符 (-)、句点 (.)、正斜线 (/)和英文冒号 (:)。

示例

如需嵌入一个用于在 Cloud Shell 中打开示例 Git 代码库的按钮,请在代码库的 README.md 文件中添加以下 Markdown:

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

如需将相同的功能嵌入到网站中,请使用以下等效 HTML 代码段:

<a href="https://ssh.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 中打开代码库所需的参数。