Cloud Shell で開く

「Cloud Shell で開く」機能を使用すると、Cloud Console を開き、Git リポジトリを Cloud Shell に自動的にクローン作成するか、カスタム イメージで Cloud Shell を起動するリンクを公開できます。また、ターミナルに手順を表示して、ユーザーによるコンテンツの操作を手助けすることもできます。

Cloud Shell で開く機能を使えば、デベロッパーは Cloud SDK のダウンロード、必要な依存関係のインストール、または関連するソースファイルの検索について心配することなく、コードサンプルや API を試すことができます。 このページでは、Git リポジトリにこの機能を追加する方法を説明します。

URL パラメータ

[Cloud Shell で開く] リンクは Git リポジトリ内の任意のディレクトリの README.md に追加できます。追加の際にはオプションでボタンイメージに埋め込むこともできます。このリンクは Git リポジトリのルート README.md に追加することをおすすめします。

この「Cloud Shell で開く」操作に機能を追加するには、ベース URL の ssh.cloud.google.com(または console.cloud.google.com で始まる Cloud Console の任意のページ)を、次の 2 つの URL パラメータの少なくとも 1 つを用いて、使用する必要があります。

URL パラメータ 説明 サポートされる値
cloudshell_git_repo

クローンを作成する Git リポジトリの URL。

指定したリポジトリのクローンが作成され、プロジェクト フォルダのルートが開いて、その内容が左側のナビゲーション ペインに表示されます。

Git リポジトリの有効な URL。

これは、ホワイトリストに登録されたドメイン(GitHub または Bitbucket)とドメインで有効な文字 [a-zA-Z0-9_-.

cloudshell_image

セッション中にカスタム環境を実行するカスタム Docker イメージを指定します。これにより、Cloud Shell でリポジトリを操作するカスタムツールを提供できます。これによって、セッションの終了時に削除されるスクラッチ ホーム ディレクトリがある一時的な環境が作成されることに注意してください。

このチュートリアルは、Cloud Shell 内で「cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md」を実行することで開始できます。

Google Container Registry でホストされている Docker イメージの URL。 Docker イメージは Cloud Shell のベースイメージに基づいており、アクセスできるように一般公開されている必要があります。URL を開くと、大きな画像が Cloud Shell VM にダウンロードされるまで時間がかかります。

さらに、次のオプション パラメータを指定できます。

URL パラメータ 説明 サポートされる値

cloudshell_git_branch

クローンを作成する Git リポジトリからの特定のブランチ。「cloudshell_git_repo」が指定されている場合にのみ適用されます。デフォルトのブランチは master です。 リポジトリ内の任意の有効なブランチ。文字はホワイトリスト [a-zA-Z0-9~_-./:] に一致する必要があります。

cloudshell_working_dir

コマンドラインでユーザーに表示する作業ディレクトリ。 任意の有効なファイルパス。文字はホワイトリスト [a-zA-Z0-9〜_-./:] に一致する必要があります。

cloudshell_workspace

Cloud Shell エディタでワークスペースとして開かれるディレクトリ 任意の有効なファイルパス。文字はホワイトリスト [a-zA-Z0-9〜_-./:] に一致する必要があります。

cloudshell_open_in_editor

Cloud Shell エディタで開くファイル。このパラメータを繰り返して、開くファイルを複数指定することができます。複数指定した場合、指定した順序でファイルが開かれます。

指定されたファイルは、開いているプロジェクトの右側のエディタタブ(ファイルごとに 1 つ)で開きます。

ファイルパスは現在のディレクトリを基準とする相対パスです。working_dir パラメータが指定されている場合、これらのファイルへのパスは working_dir を基準とする相対パスとして扱われます。

任意の有効なファイルパス。文字はホワイトリスト [a-zA-Z0-9〜_-./:] に一致する必要があります。

cloudshell_print

Git リポジトリにあるファイルで、通常、ユーザーに次の手順を案内する目的でターミナルに表示する指示から構成されます。ファイルパスは現在のディレクトリを基準とする相対パスです。

working_dir パラメータが指定されている場合、このファイルへのパスは working_dir を基準とする相対パスとして扱われます。

任意の有効なファイルパス。文字はホワイトリスト [a-zA-Z0-9〜_-./:] に一致する必要があります。

cloudshell_tutorial

Git リポジトリにある Tutorial Markdown ファイルは、プロジェクトでユーザーを誘導するためのチュートリアルとして起動する指示で構成されています。ファイルパスは現在のディレクトリを基準とする相対パスです。

ファイル名が有効で正しい形式の Tutorial Markdown ファイル。

shellonly

コマンドラインのみで開きます(エディターではなく)。

「true」、「false」

Cloud Shell でサンプルの Git リポジトリを開くためのリンクを提供するには、次のスニペットなどのマークダウンを使用して、リポジトリの README.md にリンクを埋め込む必要があります。

[![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 内のリポジトリを開くために必要な URL を決定できます。