Note
GitHub Codespaces は、octocorp.ghe.com
など、GHE.com のサブドメインでは利用できません。
Note
- JetBrains IDE での GitHub Codespaces の使用は現在 パブリック プレビュー 段階であり、変更される可能性があります。
- JetBrains IDE のコードスペースで作業するには、JetBrains ゲートウェイのリリース 2023.3.* または 2024.1.* を使用する必要があります。
JetBrains IDE またはVisual Studio Code 内、あるいは GitHub CLI を使用して GitHub でアクティブまたは停止した codespace を再度開くことができます。 削除された codespace を開き直すことはできません。 「codespace ライフサイクルについて」をご覧ください。
自分のすべての codespace は、github.com/codespaces の [あなたの codespace] ページで確認できます。 このページからは、次のことを行うことができます。
- codespace を開く、停止する、または削除する。
- codespaces の所有者 (および課金先である可能性があるユーザー) を確認する (個人アカウント、または所属する組織)。 「GitHub Codespaces の請求について」をご覧ください。
- マシンの種類、サイズ、codespace の状態を確認します。
- 新しい codespace を、GitHub のテンプレートのいずれかを選択するか、 [新しい codespace] をクリックして作成する。 「テンプレートから codespace を作成する」と「リポジトリの codespace を作成する」をご覧ください。
- codespace の自動削除を防止します。 「codespace の自動削除を構成する」をご覧ください。
リポジトリ ページから codespace を再開する
GitHub でリポジトリを表示しているときに codespace をすばやく再開できます。
-
リポジトリの [コード] タブが GitHub に表示されている状態で、「,」(カンマ キー) を押します。
[codespace の再開] ページが表示されます。 これにより、現在選んでいるリポジトリのブランチで、または、pull request を表示していた場合は、その pull request のトピック ブランチで最後に使った codespace を再開できます。
-
[この codespace を再開する] をクリックします。
または、リポジトリのこのブランチに新しい codespace を作成する場合は、 [新しく作成する] をクリックします。
Note
このブランチに既存の codespace がない場合、ページは [Create codespace] というタイトルになり、ボタンのラベルには [Create a new codespace] と表示されます。
このページにすばやく戻って codespace を再開したい場合は、このページのアドレスをブックマークできます。 または、リンク内のアドレスを使って、このリポジトリで独自の codespace を作成して再開する簡単な方法を他のユーザーに教えることができます。
[あなたの codespace] ページから既存の codespace を開く
-
GitHub の左上隅にある を選択し、 コードスペース をクリックして、github.com/codespaces のページに移動します。
-
既定のエディターで codespace を開くには、codespace の名前をクリックします。 個人用設定ページで、Codespaces の既定のエディターを設定できます。「GitHub Codespaces の既定のエディターを設定する」をご覧ください。
既定以外のエディターで codespace を開くには、次のようにします。
- 開く codespace の右側にある省略記号 ( ... ) をクリックします。
- [開く] をクリックします。
- [開くアプリケーション] をクリックします。
codespace は次の中で開くことができます。
- 自分のブラウザー
- Visual Studio Code
- JetBrains Gateway
- JupyterLab
Visual Studio Code または JetBrains Gateway を選ぶ場合、選んだアプリケーションをローカル コンピューターにインストールしていることを確認する必要があります。
JupyterLab を選んだ場合は、JupyterLab アプリケーションを codespace にインストールする必要があります。 既定の開発コンテナー イメージには JupyterLab が含まれているため、既定のイメージから作成された codespace には常に JupyterLab がインストールされます。 既定のイメージについて詳しくは、「開発コンテナーの概要」と
devcontainers/images
リポジトリをご覧ください。 開発コンテナー構成で既定のイメージを使用していない場合は、devcontainer.json
ファイルにghcr.io/devcontainers/features/python
機能を追加して JupyterLab をインストールできます。 オプション"installJupyterlab": true
を含める必要があります。 詳しくは、devcontainers/features
リポジトリにあるpython
機能の Readme をご覧ください。
既存の codespace にリンクする
既存の codespace へのリンクを作成できます。 これは、頻繁に戻る先となる、有効期間の長い codespace がある場合に便利です。 https://github.com/codespaces のリンクを使用する代わりに、任意の場所にリンクを保存することもできます。
Note
ユーザー自身の codespace のみを開くことができます。 他の人があなたの codespace の 1 つへのリンクをクリックすると、404 エラー メッセージが表示されます。
次の URL パターンを使用してリンクを作成します。 これらのURL では、CODESPACE-NAME
はの codespace の表示名ではなく、literate-space-parakeet-w5vg5ww5p793g7g9
のように codespace の一意の、永続名を表します。 codespace の名前を見つけるには、https://github.com/codespaces ページ上の codespace へのリンクをコピーし、URL から codespace 名を抽出します。
リンクが開きます | リンクの構文 |
---|---|
VS Code Web クライアント | https://CODESPACE-NAME.github.dev |
指定されたワークスペースを持つ VS Code Web クライアント | https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY |
Visual Studio Code デスクトップ アプリケーション | https://github.com/codespaces/CODESPACE-NAME?editor=vscode |
JetBrains Gateway | https://github.com/codespaces/CODESPACE-NAME?editor=jetbrains |
JupyterLab | https://github.com/codespaces/CODESPACE-NAME?editor=jupyter |
既存の codespace をもう一度開く
Note
VS Code で GitHub Codespaces を使用するには、Codespaces 拡張機能をインストールする必要があります。「Visual Studio Code で GitHub Codespaces を使用する」をご覧ください。
-
VS Code デスクトップ アプリケーションで、Command + Shift + P (Mac) または Ctrl + Shift + P (Windows/Linux) を使ってコマンド パレットを開きます。
-
「Codespaces」と入力して、次のいずれかのコマンドを選びます。
- VS Code の新しいウィンドウで codespace を開くには、 [Codespaces: 新しいウィンドウで codespace を開く] を選びます
- Web エディターで codespace を開くには、 [Codespaces: ブラウザーで開く] を選びます
-
開く codespace をクリックします。
VS Code のリモート エクスプローラー ビューに移動し、開く codespace を右クリックすることで、上記のコマンドにアクセスすることもできます。
Note
リモート エクスプローラーがアクティビティ バーに表示されない場合:
- コマンド パレットにアクセスします。 たとえば、Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux) を押します。
- 次のコマンドを入力します:
details
- [コードスペース: 詳細] をクリックします。
既存の codespace にリンクする
既存の codespace へのリンクを作成できます。 これは、頻繁に戻る先となる、有効期間の長い codespace がある場合に便利です。 https://github.com/codespaces のリンクを使用する代わりに、任意の場所にリンクを保存することもできます。
Note
ユーザー自身の codespace のみを開くことができます。 他の人があなたの codespace の 1 つへのリンクをクリックすると、404 エラー メッセージが表示されます。
次の URL パターンを使用してリンクを作成します。 これらのURL では、CODESPACE-NAME
はの codespace の表示名ではなく、literate-space-parakeet-w5vg5ww5p793g7g9
のように codespace の一意の、永続名を表します。 codespace の名前を見つけるには、https://github.com/codespaces ページ上の codespace へのリンクをコピーし、URL から codespace 名を抽出します。
リンクが開きます | リンクの構文 |
---|---|
VS Code Web クライアント | https://CODESPACE-NAME.github.dev |
指定されたワークスペースを持つ VS Code Web クライアント | https://CODESPACE-NAME.github.dev?folder=/workspaces/PATH/TO/WORKSPACE/DIRECTORY |
Visual Studio Code デスクトップ アプリケーション | https://github.com/codespaces/CODESPACE-NAME?editor=vscode |
JetBrains Gateway | https://github.com/codespaces/CODESPACE-NAME?editor=jetbrains |
JupyterLab | https://github.com/codespaces/CODESPACE-NAME?editor=jupyter |
既存の codespace をもう一度開く
GitHub CLI をインストールすると、それを使用して GitHub Codespaces で操作できます。 GitHub CLI のインストール手順については、GitHub CLI リポジトリを参照してください。
-
ターミナルで、次のいずれかの GitHub CLI コマンドを入力します。
-
VS Code で codespace を開くには、次のように入力します。
Shell gh codespace code
gh codespace code
Note
ローカル コンピューターに VS Code がインストールされている必要があります。 VS Code のドキュメントの「Visual Studio Code の設定」をご覧ください。
-
ブラウザーで codespace を開くには、次のように入力します。
Shell gh codespace code --web
gh codespace code --web
-
JupyterLab で codespace を開くには、次のように入力します。
Shell gh codespace jupyter
gh codespace jupyter
Note
JupyterLab アプリケーションは、開いている codespace にインストールされている必要があります。 既定の開発コンテナー イメージには JupyterLab が含まれているため、既定のイメージから作成された codespace には常に JupyterLab がインストールされます。 既定のイメージについて詳しくは、「開発コンテナーの概要」と
devcontainers/images
リポジトリをご覧ください。 開発コンテナー構成で既定のイメージを使用していない場合は、devcontainer.json
ファイルにghcr.io/devcontainers/features/python
機能を追加して JupyterLab をインストールできます。 オプション"installJupyterlab": true
を含める必要があります。 詳しくは、devcontainers/features
リポジトリにあるpython
機能の Readme をご覧ください。 -
コマンド ラインから codespace にアクセスするには、SSH 経由で次のように入力します。
Shell gh codespace ssh
gh codespace ssh
-
-
方向キーを使って、開きたい codespace に移動します。
-
codespace を開くには、Enter キーを押します。
GitHub CLI マニュアル内の「gh codespace code
」を参照してください。
既存の codespace をもう一度開く
JetBrains Gateway を既定のエディターとして設定している場合、GitHub から codespace を開くと、Gateway が自動的に起動します。
JetBrains Gateway が既定のエディターではない場合でも、github.com/codespaces にある [あなたの Codespaces] ページに移動し、開く codespace の右側にある省略記号 (...) をクリックすることによって、JetBrains で codespace を開くことができます。 詳しくは、「既存の codespace を開く」を参照してください。
または、JetBrains Gateway を開き、次の手順で説明するように、既存の codespace を選ぶこともできます。
-
JetBrains Gateway アプリケーションを開きます。
-
[Codespaces に接続する] をクリックします。
-
[あなたの Codespaces] リストで、作業する codespace をクリックします。
-
"使用可能な IDE" リストで、使用する JetBrains IDE をクリックします。 Gateway は、次回 codespace に接続するときのために、選んだ項目を記憶します。
-
[Connect] をクリックします。
Note
-
JetBrains IDE として Rider を選び、リポジトリに複数のソリューション ファイルが含まれている場合は、[ソリューション パスの設定] ダイアログが表示され、作業するソリューションを選ぶように求められます。 ドロップダウン メニューからソリューション ファイルを選び、 [OK] をクリックします。
リポジトリにソリューション ファイルが含まれていない場合、Rider は基本プロジェクト ディレクトリ ビューで開き、機能が制限されます。 たとえば、.NET 固有のコード ナビゲーションは取得できません。 リポジトリに 1 つのソリューション ファイルしかない場合は、それが自動的に使用され、プロンプトは表示されません。 詳しくは、JetBrains ドキュメントの「プロジェクトとソリューションを作成して開く (Create and open projects and solutions)」をご覧ください。
-
ファイアウォールを実行している場合、リモート リソースに初めて接続するときに、お使いのネットワーク経由での JetBrains Gateway による通信を許可するように求められる場合があります。
-