Contents
1. 前提条件と環境チェック
| 必要項目 | 確認方法・備考 |
|---|---|
| GitHub アカウント | 未所持の場合は https://github.com/join から作成。 |
GitHub CLI (gh) |
winget install GitHub.cli → gh --version でバージョンが表示されれば OK。PATH が通っていない場合は、インストール先(例: %USERPROFILE%\AppData\Local\GitHubCLI\bin)を環境変数に追加。 |
| WinGet | Windows 10 2004 以降・Windows 11 は標準搭載。winget --version が実行できれば使用可能。未インストール時は Microsoft Store の「App Installer」から導入。 |
ポイント
すべての項目が確認できたら、次章へ進めます。
2. WinGet でのインストール手順(公式パッケージ ID 確認)
2‑1. パッケージ ID の最新情報を取得
公式ドキュメント(https://docs.github.com/ja/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli)では、現在のパッケージ ID は GitHub.Copilot と記載されています。過去に GitHub.CopilotCLI が使用されていたことがありますが、最新リポジトリは GitHub.Copilot に統一されました。
⚠️ 注意
この記事執筆時点の情報ですので、導入前にwinget search copilotで実際の ID を再確認してください。
2‑2. インストール手順
|
1 2 3 4 5 6 |
# パッケージ一覧から正式名称を検索(任意) winget search GitHub.Copilot # 最新版をインストール winget install GitHub.Copilot |
- インストール完了の確認
powershell
winget list | findstr /i "Copilot"
copilot --version # バージョンが表示されれば成功
2‑3. 「最新版」取得の考え方
WinGet はリポジトリにプッシュされた最新ビルドを自動で提供します。バージョン番号は環境ごとに変わるため、数値を書き込む代わりに 「公式サイトで現在の最新バージョンを確認」 というフローを推奨します。
3. npm での代替インストール(OS 非依存)
3‑1. 前提:Node.js のインストール
- LTS バージョンを公式サイト (https://nodejs.org/ja) から取得。
- インストール後、
node -v && npm -vが正しく表示されることを確認。
3‑2. インストールコマンド
|
1 2 |
npm install -g @github/copilot-cli |
- グローバルに
copilotコマンドが配置されます。 - PATH の設定:インストール先(例:
%AppData%\npm)が自動で PATH に追加されない場合は、手動で環境変数に登録してください。
3‑3. バージョン確認
|
1 2 |
copilot --version |
ポイント
npm 版は Windows・macOS・Linux のすべてで同一コマンドになるため、マルチプラットフォーム環境を構築する際のバックアップ手段として有用です。
4. 初回認証フローと基本コマンド
4‑1. GitHub CLI (gh) でのログイン
|
1 2 |
gh auth login --web # 対話式にブラウザが起動し、GitHub アカウントで認可 |
--with-tokenオプションを使う場合は、シークレット変数からトークン文字列を渡します。
powershell
echo "$GH_TOKEN" | gh auth login --with-token
4‑2. Copilot CLI の認証
|
1 2 |
copilot auth login |
- 実行後にブラウザが自動で開き、「Authorize GitHub Copilot CLI」 をクリックすれば完了します。
ghと同様にトークン方式での認証は不要です(公式では非推奨)。
4‑3. 動作確認コマンド例
|
1 2 |
copilot suggest --prompt "Create a Python function that sorts a list" |
期待される出力(抜粋):
|
1 2 3 4 |
def sort_list(lst): """Return a new list with the elements sorted.""" return sorted(lst) |
ポイント
認証が成功したら、どんなプログラミング言語でも同様のcopilot suggestが利用可能です。
5. 更新・アンインストール
| 方法 | コマンド |
|---|---|
| WinGet で更新 | winget upgrade GitHub.Copilot |
| WinGet で削除 | winget uninstall GitHub.Copilot |
| npm で削除 | npm uninstall -g @github/copilot-cli |
- 更新は 定期的に実行(例: 月1回)することで、最新機能とセキュリティ修正を取り込めます。
- アンインストール後に残る設定ファイルは
%USERPROFILE%\.config\copilotなどに格納されているので、完全に削除したい場合は手動でフォルダをごみ箱へ。
6. トラブルシューティング集
| 症状 | 原因例 | 対処法 |
|---|---|---|
copilot がコマンドとして認識されない |
PATH にインストール先が未登録 | %AppData%\npm(npm)または C:\Users\<user>\AppData\Local\GitHubCLI\bin(gh)を環境変数に追加 |
| WinGet でパッケージ取得エラー | プロキシ設定が無い/不正 | setx HTTP_PROXY http://proxy.example.com:8080、setx HTTPS_PROXY http://proxy.example.com:8080 を実行し、再度インストール |
| 認証画面が表示されない | gh auth login が未実施 |
まず gh auth login --web で GitHub CLI の認証を完了させる |
| インストール後にバージョンが古い | キャッシュされた旧パッケージが残っている | winget upgrade --all または npm cache clean --force 後、再インストール |
ヒント
公式ドキュメントの「FAQ」や GitHub Discussions は随時更新されているため、エラーコードが出たらまず検索してみると解決策が見つかりやすいです。
7. CI/CD パイプラインへの組み込み例(GitHub Actions)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# .github/workflows/copilot.yml name: Copilot CLI Demo on: push: branches: [ main ] jobs: suggest: runs-on: windows-latest steps: - uses: actions/checkout@v4 # GitHub CLI のインストール(WinGet が利用できない環境向けに npm 版も併記) - name: Install GitHub CLI run: | winget install GitHub.cli || (npm install -g @github/cli) # Copilot CLI のインストール - name: Install Copilot CLI run: | winget install GitHub.Copilot || (npm install -g @github/copilot-cli) # GitHub トークンでの認証(シークレットから取得) - name: Authenticate GitHub CLI env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | echo "$GH_TOKEN" | gh auth login --with-token # Copilot の認証は gh が認証済みであれば自動的に有効になるため省略可 - name: Generate code suggestion run: | copilot suggest --prompt "Create a Node.js function that reads a JSON file" |
重要ポイント
gh auth login --with-tokenが公式で推奨されるトークン認証方法です。copilot auth loginにトークンを直接渡すオプションは現行ドキュメントでは非推奨のため、上記例では省略しています(ghの認証情報が自動的に共有されます)。- WinGet が利用できないランナー向けに npm フォールバックを用意しているので、環境依存の失敗リスクを低減できます。
8. まとめ
- 必須前提:GitHub アカウント、
gh(CLI)、WinGet(または npm)。 - インストールは
winget install GitHub.Copilotが最もシンプル。公式パッケージ ID は随時確認してください。 - 代替手段として
npm install -g @github/copilot-cliを用意すれば、OS に依存しない導入が可能です。 - 認証フローは
gh auth login --web→copilot auth loginの二段階で完了し、トークンを直接渡す必要はありません。 - 更新・削除は WinGet または npm コマンドで一行で管理でき、定期的なアップデートが推奨されます。
- CI/CD への組み込みでは
gh auth login --with-tokenが安全かつ公式にサポートされた方法です。
これらの手順を踏めば、Windows 環境でも GitHub Copilot CLI を即座に利用開始でき、生産性向上につなげることができます。