GitHub Codespaces

GitHub Codespaces は、長期的なプロジェクトであろうと、プルリクエストのレビューのような短期的なタスクであろうと、あらゆるアクティビティに対応するクラウドベースの開発環境を提供します。これらの環境は、Visual Studio Code またはブラウザベースのエディターから利用できます。

環境

環境は、GitHub Codespaces の「バックエンド」の半分です。コンパイル、デバッグ、復元など、ソフトウェア開発に関連するすべての計算処理がここで行われます。新しいプロジェクトに取り組む必要がある場合、新しいタスクに取り組む場合、または PR をレビューする場合、クラウドホスト型の環境を簡単に立ち上げることができ、GitHub Codespaces が適切に構成します。ソースコード、ランタイム、コンパイラー、デバッガー、エディター、カスタムドットファイル構成、関連するエディター拡張機能など、プロジェクトに取り組むために必要なすべてを自動的に構成します。

カスタマイズ

GitHub Codespaces は、プロジェクトごとに完全にカスタマイズ可能です。これは、VS Code Dev Containers 開発と同様に、プロジェクトのリポジトリに devcontainer.json ファイルを含めることで実現します。

カスタマイズの例を以下に示します。

• 使用する Linux ベースのオペレーティングシステムを設定します。
• さまざまなツール、ランタイム、フレームワークを自動的にインストールします。
• 一般的に使用されるポートを転送します。
• 環境変数を設定します。
• エディターの設定を構成し、推奨される拡張機能をインストールします。

codespace 固有の devcontainer.json 設定については、Codespaces の構成 ドキュメントを参照してください。

ユーザー構成ごとのドットファイル

ドットファイルとは、ファイル名がドット (.) で始まるファイルのことです。通常、アプリケーションの構成情報が含まれており、ターミナル、エディター、ソース管理、およびその他のさまざまなツールの動作を制御できます。.bashrc、.gitignore、および .editorconfig は、開発者が一般的に使用するドットファイルの例です。

Codespace の作成時に、ドットファイルを含む GitHub リポジトリ、ファイルのターゲットロケーション、およびインストールコマンドを指定できます。

ドットファイル構成を codespace に追加する方法については、Codespaces のパーソナライズ ドキュメントを参照してください。

はじめに

GitHub Codespaces クライアントの両方について、入門トピックがあります。これらは、GitHub Codespaces へのサインイン、最初の codespace の作成、およびお好みのクライアントでの接続を迅速に進めることができます。

• VS Code の Codespaces - GitHub Codespaces 拡張機能を使用して、環境に接続して作業します。
• ブラウザの Codespaces - ブラウザベースのエディターを介して codespace に接続します。

拡張機能の作成者

VS Code 拡張機能 API は、リモートで実行する実装の詳細のほとんどを隠蔽しているため、多くの拡張機能は GitHub Codespaces 環境で修正なしで動作します。ただし、すべての機能が期待どおりに動作することを確認するために、codespace で拡張機能をテストすることをお勧めします。詳細については、リモート開発と GitHub Codespaces のサポート に関する記事を参照してください。

ブラウザベースのエディター

また、ブラウザ内で完全に無料の軽量な Visual Studio Code エクスペリエンスを利用できます。Web ベースのエディターを使用すると、GitHub からソースコードリポジトリを安全かつ迅速に参照し、軽量なコード変更を行うことができます。エディターで任意のリポジトリ、フォーク、またはプルリクエストを開くことができ、検索や構文の強調表示など、VS Code の多くの機能があります。コードを実行またはデバッグする場合は、クラウドホスト型の環境または VS Code デスクトップに切り替えることができます。

このブラウザベースのエディターにアクセスするには、github.com でリポジトリに移動し、. (ピリオドキー) を押すか、リポジトリの URL を github.dev/org/repo に変更して、github.com を github.dev に置き換えます。

制限事項: ブラウザを Incognito モードで実行している場合、または広告ブロッカーが有効になっている場合は、Web ベースのエディターを使用できない場合があります。

注: このエディターは現在テクニカルプレビュー中です。今日お試しいただき、https://github.co/browser-editor-feedback でフィードバックを提供してください。

既知の制限事項と対応

Codespaces、特に Web 版 VS Code を操作する場合、留意すべき特定の制限事項があります。これらの制限事項の一部には、一貫した開発エクスペリエンスを提供するための回避策または対応策が用意されています。

いくつかの問題 (特にキーボードショートカットやデスクトップの回避策がリストされているもの) については、Codespace を プログレッシブ Web アプリケーション (PWA) としてインストールして使用できます。

一部の拡張機能は Web で動作が異なります

よくある質問

拡張機能がブラウザにインストールできないのはなぜですか

デスクトップで実行する必要がある組み込みの前提条件がある、またはデスクトップで実行する必要がある拡張機能は少数です。例としては、拡張機能がデスクトップ上の VS Code インストールからファイルにアクセスする場合や、拡張機能がデスクトップ環境で実行する必要がある実行可能ファイルに依存する場合などがあります。ブラウザでそのような拡張機能をインストールしようとすると、拡張機能が利用できないことが通知されます。

注意 このような拡張機能は、デスクトップで実行されている VS Code から Codespace に接続する場合でも使用できます。

VS Code が読み取りのためにクリップボードにアクセスすることを許可するにはどうすればよいですか?

場合によっては、VS Code がクリップボードから読み取る際にクリップボードへのアクセス許可を求めることがあります。ブラウザの設定 (「サイトのアクセス許可」を検索) から、または右側のアドレスバーでこのオプションを探して、ブラウザからクリップボードへのアクセスを許可できるはずです

VS Code にクリップボードへのアクセスを許可したら、操作を再試行できます。

VS Code が常に新しいタブとウィンドウを開くことを許可するにはどうすればよいですか?

ブラウザは、セキュリティ対策として、VS Code が新しいタブまたはウィンドウを開くのをブロックすることがあります。これが発生した場合、VS Code はブロックアクションを検出し、ユーザーに明示的にプロンプトを表示します。ただし、ブラウザナビゲーションバーのコンテキストメニューからサイト設定を開き、ポップアップウィンドウ を許可することで、VS Code が常に新しいウィンドウとタブを開くことを許可できます。

ブラウザで VS Code がローカルファイルとフォルダーにアクセスすることを許可するにはどうすればよいですか?

ブラウザから VS Code でローカルファイルとフォルダーを開くには、ブラウザが File System Access API をサポートしている必要があります。今日現在、Microsoft Edge と Google Chrome の両方がこのレベルのサポートを提供しています。ブラウザで VS Code を使用するときにローカルファイルとフォルダーにアクセスする場合は、これら 2 つのブラウザのいずれかに切り替えることを検討してください。

質問またはフィードバック

質問がある場合は、GitHub Codespaces トラブルシューティングガイド を参照してください。フィードバックを提供したい場合は、GitHub Codespaces ディスカッション に問題を投稿してください。