copilot-cli-for-beginners

Chapter 00: Quick Start

歡迎!在本章中,你將安裝 GitHub Copilot CLI(命令列介面),使用你的 GitHub 帳號登入,並驗證一切運作正常。這是一個快速設定章節。當你完成安裝並開始使用後,真正的示範會在第 01 章開始!

🎯 學習目標

完成本章後,你將能夠:

⏱️ 預估時間:大約 10 分鐘(5 分鐘閱讀 + 5 分鐘實作)


✅ 先備條件

什麼是「Copilot 存取權」

GitHub Copilot CLI 需要有效的 Copilot 訂閱。你可以在 github.com/settings/copilot 檢查你的狀態。你應該會看到下列其中一種:

如果你看到「You don’t have access to GitHub Copilot」,你需要使用免費方案、訂閱付費方案,或加入有提供存取權的組織。


安裝

⏱️ 時間預估:安裝約需 2-5 分鐘,驗證身分再多 1-2 分鐘。

GitHub Codespaces(零設定)

如果你不想安裝任何先備條件,可以使用 GitHub Codespaces,裡面已經準備好 GitHub Copilot CLI(你只需登入),並且預先安裝了 Python 和 pytest。

  1. Fork 本教學倉庫 到你的 GitHub 帳號
  2. 選擇 Code > Codespaces > Create codespace on main
  3. 等待幾分鐘讓容器建置完成
  4. 一切就緒!終端機會自動在 Codespace 環境中開啟。

💡 在 Codespace 驗證:執行 cd samples/book-app-project && python book_app.py help 來確認 Python 與範例應用程式可正常運作。

本機安裝

如果你想在本機執行 Copilot CLI 並搭配課程範例,請依下列步驟操作。

  1. 將課程範例複製到你的電腦:

     git clone https://github.com/github/copilot-cli-for-beginners
     cd copilot-cli-for-beginners
    
  2. 使用下列其中一種方式安裝 Copilot CLI。

    💡 不確定該選哪一種? 如果你已安裝 Node.js,建議使用 npm。否則請選擇符合你系統的安裝方式。

    ### 所有平台(npm)

     # 如果你已安裝 Node.js,這是快速取得 CLI 的方式
     npm install -g @github/copilot
    

    ### macOS/Linux(Homebrew)

     brew install copilot-cli
    

    ### Windows(WinGet)

     winget install GitHub.Copilot
    

    ### macOS/Linux(安裝腳本)

     curl -fsSL https://gh.io/copilot-install | bash
    

驗證身分

copilot-cli-for-beginners 倉庫根目錄開啟終端機,啟動 CLI 並允許存取該資料夾。

copilot

你會被要求信任包含此倉庫的資料夾(如果尚未信任)。你可以選擇僅信任一次,或永久信任。

Trusting files in a folder with the Copilot CLI

信任資料夾後,你可以用你的 GitHub 帳號登入。

> /login

接下來會發生什麼:

  1. Copilot CLI 會顯示一次性驗證碼(例如 ABCD-1234
  2. 瀏覽器會開啟 GitHub 的裝置授權頁面。如果尚未登入 GitHub,請先登入
  3. 按指示輸入驗證碼
  4. 點選「Authorize」授權 Copilot CLI 存取權
  5. 回到終端機——你已成功登入!

Device Authorization Flow - showing the 5-step process from terminal login to signed-in confirmation

裝置授權流程:終端機產生驗證碼,你在瀏覽器驗證,Copilot CLI 完成驗證。

提示:登入狀態會跨工作階段保留。除非你的 token 過期或你手動登出,只需登入一次。


驗證功能正常

步驟 1:測試 Copilot CLI

現在你已登入,讓我們驗證 Copilot CLI 是否能正常運作。在終端機啟動 CLI(如果尚未啟動):

> Say hello and tell me what you can help with

收到回應後,你可以離開 CLI:

> /exit

🎬 實際操作影片! ![Hello Demo](/00-quick-start/images/hello-demo.gif) *示範輸出會有所不同。你的模型、工具與回應可能與這裡顯示的不同。*

預期輸出:一段友善的回應,列出 Copilot CLI 的功能。

步驟 2:執行範例書籍應用程式

本課程提供一個範例應用程式,你將在課程中透過 CLI 探索並改進它(你可以在 /samples/book-app-project 看到程式碼)。在開始前,請先確認 Python 書籍收藏終端機應用程式 能正常運作。根據你的系統,請執行 pythonpython3

注意: 課程中的主要範例皆使用 Python(samples/book-app-project),因此如果你選擇本機安裝,請確保你的電腦已安裝 Python 3.10+。如果你偏好,也有 JavaScript(samples/book-app-project-js)和 C#(samples/book-app-project-cs)版本可用。每個範例資料夾內都有 README 說明如何執行該語言的應用程式。

cd samples/book-app-project
python book_app.py list

預期輸出:5 本書的清單,包括 “The Hobbit”、”1984” 和 “Dune”。

步驟 3:在書籍應用程式中試用 Copilot CLI

(如果你剛執行完步驟 2,請先回到倉庫根目錄)

cd ../..   # 如有需要,回到倉庫根目錄
copilot 
> What does @samples/book-app-project/book_app.py do?

預期輸出:書籍應用程式主要功能與指令的摘要。

如果出現錯誤,請參考下方的 疑難排解 區段。

完成後你可以離開 Copilot CLI:

> /exit

✅ 你已準備就緒!

安裝就到這裡。真正的重頭戲會在第 01 章開始,你將會:

繼續前往第 01 章:First Steps →


疑難排解

“copilot: command not found”

CLI 尚未安裝。請嘗試其他安裝方式:

# 如果 brew 失敗,請試試 npm:
npm install -g @github/copilot

# 或者安裝腳本:
curl -fsSL https://gh.io/copilot-install | bash

“You don’t have access to GitHub Copilot”

  1. 請在 github.com/settings/copilot 確認你有 Copilot 訂閱
  2. 如果你使用公司帳號,請確認你的組織允許 CLI 存取

“Authentication failed”

請重新驗證身分:

copilot
> /login

瀏覽器未自動開啟

請手動前往 github.com/login/device 並輸入終端機顯示的驗證碼。

Token 過期

只需再次執行 /login

copilot
> /login

還是卡住了?


🔑 重點整理

  1. GitHub Codespace 是快速入門的好選擇——Python、pytest 和 GitHub Copilot CLI 都已預先安裝,你可以直接開始實作
  2. 多種安裝方式——可依你的系統選擇 Homebrew、WinGet、npm 或安裝腳本
  3. 一次性驗證身分——登入狀態會保留直到 token 過期
  4. 書籍應用程式可正常運作——你會在整個課程中使用 samples/book-app-project

📚 官方文件安裝 Copilot CLI(安裝方式與需求)

📋 快速參考:完整指令與快捷鍵請見 GitHub Copilot CLI 指令參考


繼續前往第 01 章:First Steps →