[Cloud Shell で開く] 機能を使用すると、Git リポジトリのクローンを Cloud Shell に作成して Google Cloud Console を開くリンクや、Cloud Shell をカスタム イメージで起動するリンクを公開できます。ユーザーがコンテンツを操作できるように、手順を端末に出力できます。
[Cloud Shell で開く] リンクを使用すると、デベロッパーは、Google Cloud CLI のダウンロード、必要な依存関係のインストール、関連するソースファイルの検索を行うことなく、コードサンプルと API をテストできます。このページでは、[Cloud Shell で開く] リンクを Git リポジトリに追加する方法について説明します。
URL パラメータ
[Cloud Shell で開く] リンクは Git リポジトリ内の任意のディレクトリの README.md に追加できます。追加の際にはオプションでボタンイメージに埋め込むこともできます。このリンクは Git リポジトリのルート README.md に追加することをおすすめします。
必須の URL パラメータ
このリンクを作成するには、次の必要な URL パラメータを使用して、shell.cloud.google.com のベース URL（または Google Cloud コンソールの console.cloud.google.com で始まる任意のページ）を使用します。
| URL パラメータ | 説明 | サポートされる値 |
|---|---|---|
cloudshell_git_repo |
クローンを作成する Git リポジトリの URL。 リポジトリのクローンを作成すると、プロジェクト フォルダのルートが開いて、その内容が左側のナビゲーション ペインに表示されます。 |
Git リポジトリの有効な URL。 この URL は、許可されたドメイン（GitHub または Bitbucket）とパスで構成されています。使用できる文字は、大文字と小文字、数字、アンダースコア（_）、ハイフン（-）、ピリオド（/）、スラッシュ（/）です。 |
オプションの URL パラメータ
次のオプション パラメータのいずれかを指定することもできます。
| URL パラメータ | 説明 | サポートされる値 |
|---|---|---|
cloudshell_git_branch
|
Git リポジトリからクローンを作成するブランチ。cloudshell_git_repo が指定されている場合にのみ適用されます。デフォルトのブランチは master です。 | リポジトリ内の任意の有効なブランチ。使用できる文字は、大文字と小文字、数字、チルダ（~）、アンダースコア（_）、ハイフン（-）、ピリオド（.）、スラッシュ（/）、コロン（:）です。 |
cloudshell_image
|
セッション中にカスタム環境を実行するカスタム Docker イメージ。これにより、ユーザーがリポジトリを操作するために使用できる Cloud Shell にカスタムツールを提供できます。 このパラメータを指定して Cloud Shell でリポジトリを開くと、セッションが終了するとスクラッチ ホーム ディレクトリを含む一時環境が作成されます。 |
Container Registry でホストされている Docker イメージの URL。Docker イメージは Cloud Shell のベースイメージに基づいており、アクセスできるように一般公開されている必要があります。 有効なイメージを作成するには、Cloud Shell で次のコマンドを実行して開始できるカスタム イメージ作成のチュートリアルを使用します。
また、URL を開いた際に、サイズが大きなイメージを Cloud Shell VM にダウンロードするには時間を要する点に留意してください。 |
cloudshell_open_in_editor
|
Cloud Shell エディタで開くファイル。このパラメータを繰り返して、開くファイルを複数指定することができます。複数指定した場合、指定した順序でファイルが開かれます。 指定されたファイルは、開いているプロジェクトの右側のエディタタブ（ファイルごとに 1 つ）で開きます。 ファイルパスは現在のディレクトリを基準とする相対パスです。working_dir パラメータが指定されている場合、これらのファイルへのパスは working_dir を基準とする相対パスとして扱われます。 |
次の文字で構成される有効なファイルパス。大文字と小文字、数字、チルダ（~）、アンダースコア（_）、ハイフン（-）、ピリオド（.）、スラッシュ（/）、コロン（:）を使用できます。 |
cloudshell_print
|
Git リポジトリにあるファイルで、通常、ユーザーに次の手順を案内する目的でターミナルに表示する指示から構成されます。ファイルパスは現在のディレクトリを基準とする相対パスです。 working_dir パラメータが指定されている場合、このファイルへのパスは working_dir を基準とする相対パスとして扱われます。 |
次の文字で構成される有効なファイルパス。大文字と小文字、数字、チルダ（~）、アンダースコア（_）、ハイフン（-）、ピリオド（.）、スラッシュ（/）、コロン（:）を使用できます。 |
cloudshell_tutorial
|
Git リポジトリにある Tutorial Markdown ファイルは、プロジェクトでユーザーを誘導するためのチュートリアルとして起動する指示で構成されています。ファイルパスは現在のディレクトリを基準とする相対パスです。 |
ファイル名が有効で正しい形式の Tutorial Markdown ファイル。 |
cloudshell_working_dir （非推奨） |
このパラメータは廃止されました。 |
次の文字で構成される有効なファイルパス。大文字と小文字、数字、チルダ（~）、アンダースコア（_）、ハイフン（-）、ピリオド（.）、スラッシュ（/）、コロン（:）を使用できます。 |
cloudshell_workspace
|
Cloud Shell の作業ディレクトリ。指定したディレクトリでターミナルが開きます。Cloud Shell エディタで、ディレクトリがワークスペースとして開かれます。 | クローンを作成したリポジトリに関連する有効なファイルパス。クローンされたリポジトリのルートを指定するには、パラメータ値は空にしておくか、. を使用できます。リポジトリが指定されていない場合、パスは Cloud Shell ホーム ディレクトリからの相対パスになります。使用できる文字は、大文字と小文字、数字、チルダ（~）、アンダースコア（_）、ハイフン（-）、ピリオド（.）、スラッシュ（/）、コロン（:）です。 |
ephemeral |
このパラメータを指定して Cloud Shell でリポジトリを開くと、セッションが終了するとスクラッチ ホーム ディレクトリを含む一時環境が作成されます。詳細については、エフェメラル モードの選択をご覧ください。 |
|
show
|
ターミナルのみ、Cloud Shell エディタのみ、または両方で開きます。 |
|
Examples
Cloud Shell でサンプル Git リポジトリを開くボタンを埋め込むには、リポジトリの README.md ファイルに次のマークダウンを含めます。
[](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 内のリポジトリを開くために必要なパラメータをテストします。