Go to Qiita Advent Calendar Top
LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@Hurry_Fox(は〜りぃふぉっくす 雪の魔王編)

Tips - GitHub Copilot利用時の個人設定について

Posted at

Tips - GitHub Copilot利用時の個人設定について

GitHub Copilot を実際の開発業務で活用するには、適切な環境設定が不可欠です。本記事では、Visual Studio Code における Copilot の設定方法、企業ネットワーク環境での利用、そして GitHub Enterprise Cloud (GHE.com) アカウントでの認証方法について、実践的な観点から解説します。

1. Visual Studio Code での基本設定

1.1 インライン提案の制御

Copilot のインライン提案は、コーディング中にリアルタイムで補完候補を表示する機能です。この機能の有効化・無効化は、以下の2つの方法で行えます。

方法1: クイック設定

  1. VS Code のタイトルバーにある Copilot アイコン横の矢印をクリック
  2. 「Configure Inline Suggestions」を選択
  3. 表示されるダイアログで「Enable Completions」または「Disable Completions」を選択

方法2: 設定画面から

  1. File メニュー → Preferences → Settings を開く
  2. 左パネルで Extensions → Copilot を選択
  3. 「Inline Suggest:Enable」のチェックボックスで制御

1.2 キーボードショートカットのカスタマイズ

デフォルトのキーボードショートカットを、独自のワークフローに合わせてカスタマイズすることが可能です。

Keyboard Shortcuts エディタで、コマンド名で検索してショートカットを再バインドできます。

1.3 言語別の有効化制御

プロジェクトの性質によっては、特定の言語でのみ Copilot を使用したい場合があります。これは settings.json で細かく制御できます。

  1. VS Code の設定画面で Extensions → Copilot セクションに移動
  2. 「Enable or disable Copilot for specified languages」の「Edit in settings.json」をクリック
  3. 以下のように言語ごとに設定を記述
{
    "editor.inlineSuggest.enabled": true,
    "github.copilot.enable": {
        "*": true,
        "yaml": false,
        "plaintext": false,
        "markdown": true,
        "javascript": true,
        "python": true
    }
}

この設定例では、YAML とプレーンテキストでは Copilot を無効化し、Markdown、JavaScript、Python では有効化しています。"*": true は、明示的に指定されていない言語すべてで有効化することを意味します。

1.4 Next Edit Suggestions の有効化

Next Edit Suggestions は、次に編集すべき箇所を提案する機能です。これを有効化するには、VS Code の設定で github.copilot.nextEditSuggestions.enabled を設定します。

ただし、Copilot Business または Copilot Enterprise プランを使用している場合は、組織またはエンタープライズの管理者が「Editor preview features」設定を有効にする必要があります。

1.5 認証の取り消しと再認証

デバイスの変更やセキュリティ上の理由で、特定のデバイスからの Copilot アクセスを無効化したい場合の手順です。

認証の取り消し

  1. GitHub.com の右上にあるプロフィール画像をクリックし、「Settings」を選択
  2. サイドバーの「Integrations」セクションで「Applications」をクリック
  3. 「Authorized OAuth Apps」タブで「GitHub for VS Code」の「...」から「Revoke」を選択
  4. 「Authorized GitHub Apps」タブで GitHub Copilot 拡張機能がリストされている場合、「Revoke」をクリック

認証を取り消した後も、現在のセッションでは最大30分間 Copilot を使用できます。その後、再認証が必要になります。

再認証の手順

  1. VS Code 左下の Accounts アイコンをクリックし、ユーザー名にカーソルを合わせて「Sign out」を選択
  2. ポップアップで「Sign Out」を確認
  3. 再度 Accounts アイコンをクリックし、「Sign in with GitHub to use GitHub Copilot」を選択
  4. ブラウザで必要な権限を承認し、「Continue」をクリック
  5. 「Open Visual Studio Code?」ポップアップで「Open Visual Studio Code」をクリック

2. 企業ネットワーク環境での設定

企業環境では、HTTP プロキシやカスタム証明書が必要になることがあります。Copilot はこれらの環境に対応しています。

2.1 プロキシ設定

設定手順

  1. File メニュー → Preferences → Settings を開く
  2. 左パネルで Application → Proxy を選択
  3. 「Proxy」のテキストボックスにプロキシサーバーのアドレスを入力（例: http://localhost:3128）
  4. オプション: 証明書エラーを無視する場合は「Proxy Strict SSL」のチェックを外す

警告: 証明書エラーを無視することはセキュリティリスクを伴うため、推奨されません。

2.2 基本認証

VS Code 用の Copilot は基本認証をサポートしています。認証情報をプロキシ URL に含めることができます。

http://yamada_tarou:password123@10.203.0.1:5187/

この URL は VS Code の設定、または環境変数に保存できます。

2.3 Kerberos SPN のオーバーライド

企業の認証システムで Kerberos を使用している場合、デフォルトの SPN (Service Principal Name) をオーバーライドする必要がある場合があります。

  1. Shift+Command+P (Mac) または Ctrl+Shift+P (Windows/Linux) でコマンドパレットを開く
  2. settings と入力し、「Preferences: Open User Settings (JSON)」をクリック
  3. JSON オブジェクトに以下のプロパティを追加
"http.proxyKerberosServicePrincipal": "YOUR-SPN",

YOUR-SPN は、プロキシサービスの正しい SPN に置き換えてください。

2.4 カスタム証明書のインストール

企業によっては、独自の証明書を使用している場合があります。通常、IT 部門がこれらの証明書を事前にインストールしていますが、手動でインストールする必要がある場合もあります。

重要な注意事項: カスタム証明書をインストールすることは、その証明書の作成者を信頼し、その作成者があなたのマシンからのすべてのインターネットトラフィックを傍受できる可能性があることを意味します。正しい証明書をインストールしていることを慎重に確認してください。

OS別のインストール方法

  • Windows: Microsoft ドキュメントの「Installing the trusted root certificate」を参照
  • macOS: Keychain Access User Guide の「Add certificates to a keychain using Keychain Access on Mac」を参照
  • Linux: Ubuntu ドキュメントの「Installing a root CA certificate in the trust store」を参照（他の Linux ディストリビューションでも同様の手順が適用されます）

証明書をインストールしても Copilot が検出しない場合は、GitHub のトラブルシューティングガイドを参照してください。

3. GitHub Enterprise Cloud (GHE.com) アカウントでの利用

GHE.com のマネージドユーザーアカウントで Copilot プランを使用している場合、IDE で認証する前にいくつかの設定を調整する必要があります。

3.1 認証設定のフロー

3.2 詳細な設定手順

1. Enterprise URI の設定

  1. VS Code の設定を開く（Command+, (Mac) または Ctrl+, (Windows)）
  2. 検索バーで enterprise を検索
  3. 「Github-enterprise: Uri」設定に、GitHub にアクセスする URL を入力（例: https://octocorp.ghe.com）

2. 認証プロバイダーの設定

  1. VS Code の設定で copilot を検索
  2. 「GitHub > Copilot: Advanced」セクションで「Edit in settings.json」をクリック
  3. github.copilot.advanced プロパティ内に "authProvider": "github-enterprise" を追加
"github.copilot.advanced": {
     "authProvider": "github-enterprise"
},

3. 認証の実行

  1. settings.json ファイルを保存
  2. サインインを求めるプロンプトが表示される
  3. 「Sign in to GitHub」をクリックし、表示される手順に従ってアカウントを認証

プロンプトが表示されない場合は、VS Code を再起動してください。

GitHub.com のアカウントに切り替える場合

GHE.com から GitHub.com のアカウントに切り替える必要がある場合は、settings.json から authProvider 設定を削除するだけです。

4. GitHub.com での Copilot ポリシー設定

Copilot Pro プランを使用している場合、GitHub.com の個人設定で以下の項目を管理できます。

  • 公開コードと一致するインライン提案を許可またはブロック
  • 入力したプロンプトと Copilot の提案の収集と保持を許可またはブロック

これらの設定は、GitHub.com の個人アカウント設定から行います。

5. まとめ

GitHub Copilot を効果的に活用するには、開発環境に応じた適切な設定が重要です。

  • 基本設定: インライン提案の制御と言語別の有効化で、開発スタイルに合わせた使用が可能
  • 企業環境: プロキシとカスタム証明書の設定により、セキュアなネットワーク環境でも利用可能
  • Enterprise 環境: GHE.com アカウントでも、適切な認証設定により Copilot を活用可能

これらの設定を理解し、自分の開発環境に最適化することで、Copilot の能力を最大限に引き出すことができます。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?