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 体験を利用することもできます。ウェブベースのエディタを使用すると、GitHub のソースコードリポジトリを安全かつ迅速にブラウズし、軽微なコードの変更を行うことができます。任意のリポジトリ、フォーク、またはプルリクエストをエディタで開くことができ、検索や構文ハイライトなど、VS Code の機能の多くが備わっています。コードを実行またはデバッグしたい場合は、クラウドホスト型の環境やデスクトップ版の VS Code に切り替えることができます。

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

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

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

既知の制限事項と適応方法

Codespaces（特にウェブ上の VS Code）を使用する際には、留意すべきいくつかの制限事項があります。一貫した開発体験を提供するため、これらの制限の一部には回避策や適応策が用意されています。

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

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

よくある質問

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

一部の拡張機能には、あらかじめ想定されている前提条件があるか、あるいはデスクトップ上で実行する必要があります。たとえば、デスクトップ上の 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 のディスカッションにイシューを投稿してください。