🧑‍🏫

GitHub Copilot を Xcode で使う(GitHub 公式の Xcode 機能拡張)

2024/10/30に公開

GitHub Universe 2024 にて、GitHub Copilot の Xcode 機能拡張のパブリックプレビューのリリースが発表されました。

GitHub Copilot 自体は、Swift や Objective-C といった Apple プラットフォームでよく用いられるプログラミング言語についても利用できていましたが、これからは Xcode 上で GitHub Copilot を使えるようになります。GitHub Copilot を使いたいためだけに他のエディタを使用する必要はもうありません。

それでは GitHub Copilot を Xcode で使ってみましょう。

必要な環境

  • GitHub Copilot が利用可能になっている GitHub.com のアカウント
  • macOS Monterey 以降で、Xcode 8.0 以降[1]が使えるようになっている Mac
    • 本記事では macOS Sequoia で Xcode 16.1 を用いています

GitHub Copilot 機能拡張 for Xcode をダウンロード・インストール

GitHub Copilot 機能拡張 for Xcode をダウンロード・インストールする方法は2つあります。

方法1: Homebrew Cask 経由でインストール

GitHub Copilot 機能拡張 for Xcode は Homebrew Cask でインストールできます。

brew install --cask github-copilot-for-xcode

方法2: 自分で github/CopilotForXcode のリリースページ からダウンロード・インストール

GitHub Copilot 機能拡張 for Xcode の .dmg ファイルを、github/CopilotForXcode のリリースページ からダウンロードします。


本記事執筆時点での最新のバージョンは 0.27.0 でした。

.dmg ファイルがダウンロードできたら開き、「GitHub Copilot for Xcode」アプリをアプリケーションフォルダにドラッグ&ドロップしてインストールします。

アクセス権の設定

アプリケーションフォルダにインストールした「GitHub Copilot for Xcode」アプリを開きます。すると、はじめにアクセシビリティ機能へのアクセス許可が求められるので設定します。Mac の「システム設定」から、「プライバシーとセキュリティ」>「アクセシビリティ」に進み、「GitHub Copilot for Xcode Extension」を許可します。

その後、「GitHub Copilot for Xcode」アプリに戻ると Xcode Source Editor のアクセス権も求められるので、そちらも設定します。「システム設定」の「一般」>「ログイン項目と機能拡張」>「Xcode Source Editor」に進み、「GitHub Copilot for Xcode Extension」を許可します。

「GitHub Copilot for Xcode」アプリで GitHub にログインする

「GitHub Copilot for Xcode」アプリの「Copilot Connection」にある「GitHub Account Status Permissions」で、「Login to GitHub」のボタンが表示されている場合には、それを押して GitHub へログインします。

ログインのためのコードが表示されますが、「Copy Code and Open」を押すことでクリップボードにそのコードがコピーされるので、覚えておく必要ありません。ブラウザが起動し、GitHub の Device Activation ページが開くので、コピーされているコードをペーストして「Continue」し、「Authorize GitHub Copilot Plugin」します。

ログインが完了すると、「GitHub Connection: OK」と表示され、ボタンも「Logout from GitHub」へと変わっています。もしステータスが変化しない場合は、「Refresh Connection」ボタンを押してください。

Xcode で使ってみる

ここまでで GitHub Copilot 機能拡張 for Xcode の準備は完了です。Xcode で好きなプロジェクトを開いてみましょう。

Visual Studio Code や JetBrains の各 IDE での使い心地と同じように、Xcode でも GitHub Copilot が使えます…!!!

デフォルトで設定されているキーバインディング

Xcode での GitHub Copilot でのキーバインディングをまとめます。

入力キー 動作
Tab 提案されたコードを受け入れる(入力する)
Option 複数行の提案の場合にそのすべてを表示する
Option + Tab 複数行の提案をすべて表示している(Option キーを押しっぱなしにしている)状態から、そのコード提案を受け入れる(入力する)

キーバインディングが設定されていないメニューと、キーバインディングのカスタマイズ

また、Xcode の「Editor」>「GitHub Copilot」には、編集時に使えるほかのメニューも存在します。

それらのメニュー項目にはキーバインディングが設定されていませんが、Xcode 側の機能によってカスタムでキーバインドを設定することができます。たとえば、「Next Suggestion」に Ctrl + [ を割り当ててみましょう。

Xcode の設定(Cmd + ,)から「Key Bindings」を開き、見やすいように「GitHub Copilot」でフィルタします。

キーバインドを追加したいコマンドを見つけたら、その行の右寄りをクリックしてキーバインド設定のモードに移ります。そのモードにいる間のキー入力がそのままキーバインドになります。キーバインドの入力が終わったら、マウスカーソルでキーバインド入力欄以外の任意の場所をクリックして、キーバインド設定のモードを抜けます。

改めて Xcode の「Editor」>「GitHub Copilot」を見てみると、無事に設定されたキーバインドが表示され、使えるようになっていました!

そのほかの情報

GitHub Copilot 機能拡張 for Xcode は本記事執筆時点においてパブリックプレビュー版となっていますので、使用の際には注意してください。また、フィードバックを提供したり、コミュニティに参加して GitHub Copilot 機能拡張 for Xcode のより良い発展にぜひ貢献しましょう……!!!

脚注
  1. 本記事執筆時点での最新の Xcode は 16.1 です。すごく古い Xcode でも使える… ように見えますが、macOS Monterey では通常であれば Xcode 13 以降しか動作しません 😢 ↩︎

Discussion