📝

Copilot For Xcode インストール作業

2024/02/18に公開

Xcode

GitHub Copilot

Copilot for Xcode

tech

この記事について

内容

Xcode で GitHub Copilot を使えるようにするために Copilot For Xcode をインストールした作業の覚書。

GitHub Copilot の標準の対応環境には Xcode は含まれていない
GitHub Copilot を利用できるようにする Xcode の拡張機能として、Copilot for Xcode が公開されている

作業時期と環境

作業時期: 2024年2月12日
ハードウェア: MacBook Pro (Apple M3 Pro)
システムのバージョン: macOS 14.3 (23D56)

参考にした記事など

参考記事

Copilot For Xcode

Copilot For Xcode

前提条件とこの記事の範囲

「Xcode で GitHub Copilot を利用する」 = 「Copilot For Xcode を導入する」ために行なった作業。
以下の通り、作業開始時点で、必要なソフトウェアなどはほぼ導入済みで、GitHub のアカウントは存在していたので、この記事では、GitHub Copilot のサブスクリプションの契約と、Copilot For Xcode の導入・設定がほぼすべて。

この記事に含まれないこと

GitHub Copilot の ChatGPT と連携した Chat 機能の設定方法
ChatGPT はフリー版のアカウントしか持っておらず、この作業をした時にアップグレードの受付が停止していたため。フリー版でも設定できるかがよくわからなかったので今回はスキップ
導入後のキーバインディングの設定や操作方法
別文書にした方がわかりやすいと思ったので別途作成する

必要なソフトウェア等

Xcode: 導入済み(Version 15.2 (15C500b))
Homebrew: 導入済み(Homebrew 4.2.7)
Node.js: 導入済み(v21.6.1)
(補足) Homebrew は、Copilot For Xcode や node のインストールに利用する場合。他の方法でインストールする場合は必須ではないかも

アカウント等

GitHub アカウント: あり(プランは GitHub Pro)
GitHub Copilot サブスクリプション (なし)

その他

Node.js のパスを確認しておく

% which node
/opt/homebrew/bin/node

大まかなステップ

前提条件と現在の状態から、以下のような進め方で作業

GitHub で Copilot サブスクリプションを導入
Copilot For Xcode をインストール (Homebrew を利用)
Copilot For Xcode の設定
Copilot For Xcode の有効化
(macOS のシステム設定でのセキュリティ設定等の変更)
Copilot For Xcode の動作確認

インストール作業

GitHub Copilot サブスクリプションの導入

GitHub で [Settings] の [Billing and plans] - [Plans and usage] に進むと [Add-ons] の下に GitHub Copilot の項目がある。
ここで [Enable GitHub Copilot] をクリック。

30日のトライアル終了後の支払い方法を選択して、画面に従って登録する。
すでに GitHub Pro サブスクリプションでクレジットカードが登録されているので、簡単な入力だけで、基本画面に従って進む。

完了時に、
[Select your preference] という画面で設定がある。

この設定はあとで [Settings] - [code, planning and automation] の下にある [Copilot] の画面で変更可能。

(補足) この設定の意味

ひとつめの "Suggestions matching public sode" は、GitHub Copilot に、GitHub 上で公開されている既存のコードと一致する提案を許可するかどうか。
ふたつめの "Allow GitHub to use my code snipets for product improvements" は逆に、自身のコードを、GitHub Copilot が学習データとして利用することを許可するかどうか。

Copilot For Xcode のインストール

Homebrew を利用してインストール

% brew install copilot-for-xcode

Copilot For Xcode の設定

Node.js のパスの指定

最初に Copilot For Xcode を起動したら [Service] のタブで

[Node Settings] で Node.js のパスを指定
[GitHub Copilot Language Server] でインストールとサインインを実行して Status: OK にする

サインインのところでは、８桁のコードの入力が求められるので、Copilot For Xcode でポップアップに表示されるコードを入力する。

[Authorize GitHub Copilot Plugin] をクリック