GitHub Codespaces

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

環境

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

カスタマイズ

GitHub Codespacesは、プロジェクトごとに完全にカスタマイズ可能です。これは、VS Codeの開発コンテナー開発と同様に、プロジェクトのリポジトリに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エクスペリエンスも利用できます。ウェブベースのエディターを使用すると、GitHubからソースコードリポジトリを安全かつ迅速に閲覧し、軽量なコード変更を行うことができます。検索や構文ハイライトを含むVS Codeの多くの機能を備えたこのエディターで、任意のリポジトリ、フォーク、またはプルリクエストを開くことができます。コードを実行またはデバッグしたい場合は、クラウドホスト型環境またはVS Codeデスクトップに切り替えることができます。

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

制限事項：シークレットモードでブラウザを実行している場合や、広告ブロッカーを有効にしている場合、ウェブベースのエディターを使用できないことがあります。

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

既知の制限事項と適応

Codespaces、特にウェブ版のVS Codeで作業する場合、いくつかの制限事項を考慮する必要があります。これらの制限事項の一部には、一貫した開発エクスペリエンスを提供するための回避策または適応策があります。

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

一部の拡張機能はウェブで動作が異なります。

よくある質問

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

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

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

VS Codeがクリップボードを読み取ることを許可するにはどうすればよいですか？

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

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

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

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

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

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

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

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