Skip to main content

認證

Copilot SDK 支援多種認證方式。請依用途選擇。

認證方式

關於 BYOK 請參考 Custom providers

GitHub 登入(CLI)

copilotgh CLI 已登入,且未指定其他選項,將使用已儲存的認證資訊。

OAuth GitHub App / PAT

將透過 OAuth 流程取得的使用者 access token 或 Fine-grained PAT 傳入 github_token
  • 預期為 gho_ / ghu_ / github_pat_
  • 不建議使用 ghp_(Classic PAT)
指定 github_tokenuse_logged_in_user 會自動變為 false。若想明確切換,可如下設定。
詳情請參考 GitHub tokengithub_tokenuse_logged_in_user 僅於 stdio 模式可用。TCP 模式下需在 Copilot CLI 端已完成認證。

環境變數

透過環境變數傳遞 token 時,CLI 會自動偵測。優先順序由上而下:
  1. COPILOT_GITHUB_TOKEN
  2. GH_TOKEN
  3. GITHUB_TOKEN
TCP 模式時,請於 CLI 伺服器端設定環境變數。

認證的優先順序

SDK 會依下列順序解析認證資訊。
  1. github_token(明確指定)
  2. 環境變數 token(COPILOT_GITHUB_TOKENGH_TOKENGITHUB_TOKEN
  3. CLI 中已儲存的 OAuth 認證資訊
  4. gh CLI 的認證資訊

停用自動登入

若不希望使用已儲存的認證資訊,可將 use_logged_in_user 設為 false
github_token 相同,僅支援 stdio 模式。TCP 模式下需在 Copilot CLI 端已完成認證。

確認認證狀態

可透過取得 auth.getStatus 的結果來確認。
最新資訊請參考 GitHub 儲存庫
最後修改於 2026年8月2日