跳转至

GitHub Copilot

GitHub Copilot 是 GitHub 的 AI 编程助手。它会为你的 GitHub 账户和套餐提供对 Copilot 模型的访问权限。OpenClaw 可以通过三种不同方式将 Copilot 用作模型提供方或 agent 运行时。

在 OpenClaw 中使用 Copilot 的三种方式

OpenClaw 通过原生的设备登录流程获取 GitHub 令牌。默认情况下,
OpenClaw 会将令牌放入受保护的本地密钥存储中,并且只在认证配置文件中保存
一个 `tokenRef`。OpenClaw 运行时会验证 Copilot 的访问权限,
并解析账户专属的 Copilot API 端点。这是**默认**
且最简单的路径,因为它不需要 VS Code。

1. 运行登录命令

openclaw models auth login-github-copilot

系统会提示你访问一个 URL 并输入一次性代码。请保持终端打开, 直到流程完成。

2. 设置默认模型

openclaw models set github-copilot/claude-sonnet-5

或在配置中:

{
  agents: {
    defaults: { model: { primary: "github-copilot/claude-sonnet-5" } },
  },
}

当你希望 GitHub 的 Copilot CLI 和 SDK 为选定的 github-copilot/* 模型 掌管底层 agent 循环时,请安装外部 @openclaw/copilot 插件。

openclaw plugins install @openclaw/copilot

然后将某个模型或提供方接入该运行时:

{
  agents: {
    defaults: {
      model: "github-copilot/gpt-5.6-sol",
      models: {
        "github-copilot/gpt-5.6-sol": {
          agentRuntime: { id: "copilot" },
        },
      },
    },
  },
}

当你希望这些 agent 轮次使用原生 Copilot CLI 会话、SDK 管理的线程状态 以及 Copilot 拥有的压缩时,请选择此方式。如果没有显式选择 agentRuntime, github-copilot/* 模型将继续使用内置提供方。完整运行时契约请参阅 Copilot SDK 封装。

使用 **Copilot Proxy** VS Code 扩展作为本地桥接。OpenClaw 连接
该代理的 `/v1` 端点(默认 `http://localhost:3000/v1`),并使用
你配置的模型列表。

`copilot-proxy` 插件随 OpenClaw 附带,并且默认启用。
使用以下命令配置基础 URL 和模型 ID:

```bash
openclaw models auth login --provider copilot-proxy --set-default
```

Note

当你已经在 VS Code 中运行 Copilot Proxy,或需要通过它进行路由时, 请选择此方式。VS Code 扩展必须保持运行。

GitHub Enterprise(数据驻留)

如果你的组织使用数据驻留 GitHub Enterprise 租户(*.ghe.com 主机,例如 your-org.ghe.com),Copilot 将位于租户本地端点,而非公共 github.com。 OpenClaw 将其作为一流的认证选项提供,因此你无需手动编辑 URL。

1. 选择 Enterprise 认证选项

在引导流程或 openclaw models auth 中,选择 GitHub Copilot (Enterprise / 数据驻留)。系统会提示你输入企业域(例如 your-org.ghe.com),然后设备登录将针对该租户运行。

只输入租户根域(your-org.ghe.com)。派生服务主机(例如 api.your-org.ghe.com 或 copilot-api.your-org.ghe.com)不被接受; OpenClaw 会自动从租户根域派生这些端点。

openclaw models auth login --provider github-copilot --method device-enterprise

2. 域会持久化到配置中

所选主机将存储在提供方参数下,以便后续的账户验证和补全自动指向该租户:

{
  models: {
    providers: {
      "github-copilot": { params: { githubDomain: "your-org.ghe.com" } },
    },
  },
}

设备流程和账户验证使用该租户的 GitHub 端点,Copilot 请求使用 https://copilot-api.your-org.ghe.com。这样,认证和推理都保持在已配置的 数据驻留租户上,而不是公共端点上。

Note

切换域总是会重新运行设备登录。如果你已经存储了 Copilot 令牌,并且选择了 不同的域(公共 github.com ↔ *.ghe.com 租户,或一个租户到另一个租户), OpenClaw 将不会复用现有令牌——它会强制进行全新登录,以确保令牌限定于正在写入 配置的域。针对相同域重新运行登录时,仍会提供复用当前令牌的选项。切换回公共 github.com 会清除持久化的 githubDomain,使配置恢复默认值。

只有规范化后的受支持租户范围匹配时,agents 才会共享 Copilot 凭据; Doctor 会为不同租户保留凭据,因此请为每个受影响的 agent 在其目标租户上完成 认证,而不是删除其本地凭据。

Note

COPILOT_GITHUB_DOMAIN 环境变量会覆盖每个解析该域的 Copilot 路径中的 已解析域——包括企业设备登录(--method device-enterprise)、独立的 openclaw models auth login-github-copilot 快捷方式、账户验证、嵌入和补全。 将其设置为你的 *.ghe.com 主机,可实现完全无头或 CI 环境。保持未设置状态 (且配置参数不存在)则使用公共 github.com。登录会持久化它们签发令牌时所针对的 域(并在登录公共 github.com 时清除它),因此即使环境变量被取消设置,路由也会 保持正确。

租户请求身份

OpenClaw 默认使用 copilot-developer-cli 请求身份,包括用于数据驻留租户。 首先请确认你的企业允许 Copilot CLI 和所选模型。*.ghe.com 主机名并不意味着 不同的集成策略。

如果你的租户管理员或 GitHub 支持要求使用不同的身份,请使用现有的提供商请求头设置:

{
  models: {
    providers: {
      "github-copilot": {
        params: { githubDomain: "your-org.ghe.com" },
        headers: { "Copilot-Integration-Id": "vscode-chat" },
      },
    },
  },
}

提供商身份适用于设置期间的模型选择、实时模型发现、推理和嵌入。请求头名称不区分大小写;request.headers 优先于提供商 headers。嵌入专用的 memory.search.remote.headers 在嵌入发现和请求中仍然优先。无关的提供商请求头不会转发到目录或嵌入端点。更改身份不会授予访问被组织策略禁用的模型或客户端的权限。

可选标志

命令 标志 描述
openclaw models auth login-github-copilot --yes 覆盖现有认证配置而不提示
openclaw models auth login --provider github-copilot --method device --set-default 同时应用提供商推荐的默认模型
# Skip the re-login confirmation
openclaw models auth login-github-copilot --yes

# Login and set the default model in one step
openclaw models auth login --provider github-copilot --method device --set-default

非交互式引导

设备登录流程需要交互式 TTY。对于无头设置,请使用 openclaw onboard --non-interactive 导入现有的 GitHub OAuth 访问令牌:

openclaw onboard --non-interactive --accept-risk \
  --auth-choice github-copilot \
  --github-copilot-token "$COPILOT_GITHUB_TOKEN" \
  --skip-channels --skip-health

你也可以省略 --auth-choice;传入 --github-copilot-token 会推断 GitHub Copilot 提供商认证选择。如果省略该标志,引导过程会回退到 COPILOT_GITHUB_TOKEN。通用的 GH_TOKEN 和 GITHUB_TOKEN 不会启用或认证该提供商。设置 COPILOT_GITHUB_TOKEN 并使用 --secret-input-mode ref,可在认证配置存储中保存基于环境变量的 tokenRef,而不是明文。

全新的非交互式设置会在保存前验证令牌。当设置必须选择默认值时,它还会检查实时 Copilot 模型目录。OpenClaw 优先选择提供商当前的通用模型(如果该模型已对该账户启用);否则选择确定性的合格回退。如果账户没有支持流式传输和工具调用的选择器可见模型,设置会失败且不写入新的认证配置。显式配置的默认模型永远不会被替换。

需要交互式 TTY

设备登录流程需要交互式 TTY。请直接在终端中运行,不要放在非交互式脚本或 CI 流水线中。

模型可用性取决于你的套餐

Copilot 模型可用性取决于你的 GitHub 套餐和组织策略。交互式引导使用实时目录作为模型选择器,而非交互式引导会自动选择一个合格模型。有关当前模型列表,请参阅 GitHub 的 每个 Copilot 套餐支持的模型。

从 Copilot API 刷新实时目录

一旦设备登录(或环境变量)认证路径解析出 GitHub 令牌,OpenClaw 就会按需从 ${baseUrl}/models(VS Code Copilot 使用的同一端点)刷新模型目录,以便运行时跟踪按账户权限和准确的上下文窗口,而无需清单变更。可见的实时目录会排除从 GitHub 选择器中隐藏或由账户策略禁用的模型。自动设置默认值还要求支持流式传输和工具调用。 新发布的 Copilot 模型无需升级 OpenClaw 即可显示,并且上下文窗口会反映每个模型的实际限制(例如 gpt-5.x 系列为 400k,内部 claude-opus-*-1m 变体为 1M)。

刷新失败时会报告失败,并保留最后一次成功清单,或在首次成功前保留内置模型。成功的空响应会清除已发现的模型。缺少 Copilot 凭据时不会发起实时请求。Copilot 要求在代理的模型范围内显式配置提供商、已保存的 Copilot 认证配置或 COPILOT_GITHUB_TOKEN。旧的 plugins.entries.github-copilot.config.discovery.enabled 开关已弃用。配置加载会忽略它,Doctor 在保存配置时会将其移除。它不再阻止已配置 Copilot 认证的实时请求。

传输选择

Claude 模型 ID 会自动使用 Anthropic Messages 传输。Gemini 模型使用 OpenAI Chat Completions 传输;GPT 和 o 系列模型保留 OpenAI Responses 传输。内置静态目录包含这些传输和请求兼容性设置,因此在实时发现不可用时,Gemini 仍会使用 Chat Completions。当你的账户模型列表列出了模型支持的端点,且默认传输不在其中时,OpenClaw 会改用列出的端点,因此仅支持 Chat Completions 的模型(如 kimi-k3)可以正常工作。

思考级别

当所选模型暴露该级别时,使用 /think xhigh 或 /think max。Copilot 实时目录会确定你的账户支持的 effort 级别,OpenClaw 会在 Responses 请求中保留这些 effort。当 Responses 模型的原生 effort 范围从 low 开始时,minimal 会映射为 low,而不是发送不支持的值。显式实时限制优先于内置目录。Gemini 的 Chat Completions 传输不暴露 max。实时条目列出 xhigh 的 Claude 模型,即使 OpenClaw 尚未识别其模型 ID,也会使用自适应思考。有关会话和逐消息控制,请参阅 思考级别。

请求兼容性

OpenClaw 会发送带有 Copilot CLI 请求身份标识的 Copilot 兼容请求头,将工具结果后续轮次标记为代理发起,并在轮次携带图像输入时设置 Copilot 视觉请求头。

环境凭据

COPILOT_GITHUB_TOKEN 是该提供程序唯一的自动环境凭据。 通用的 GH_TOKEN 和 GITHUB_TOKEN 仍可供其他 GitHub 工具使用, 并仍受密钥审计和清理覆盖。 当仅存在通用 GitHub 身份验证时,Doctor 会报告一次激活变更, 并提供登录或设置 COPILOT_GITHUB_TOKEN 的说明。

设备登录流程会在 Copilot 身份验证配置中存储受保护存储的 tokenRef。 显式选择的配置会保持选中状态;无范围查找可在首个已保存配置之前 使用 COPILOT_GITHUB_TOKEN。

Token 存储

默认情况下,设备登录会将 GitHub Token 存储在 OpenClaw 的受保护本地 密钥存储中,并仅向身份验证配置写入一个 tokenRef(配置 ID 为 github-copilot:github)。内置存储不需要配置外部 密钥提供程序。如果 OpenClaw 无法写入存储,登录会在 替换身份验证配置之前停止,并报告状态目录或 数据库权限需要修复。

交互式入门会出于兼容性考虑,遵循显式的 --secret-input-mode plaintext 选择。该模式会内联存储 Token,报告该选择, 并仍可通过 openclaw secrets audit --check 查看。

受保护存储仅可通过 OpenClaw 面向用户的密钥 API 进行写入, 但静态数据未加密;其 SQLite 文件依赖状态目录 权限。运行时,OpenClaw 会解析引用、验证 Copilot 访问权限、解析特定于账户的 API 端点,并使用 GitHub Token 发起 Copilot 请求。你无需手动管理运行时身份验证。

用量检查也会使用所选配置的 GitHub Token。对于携带租户域的 OAuth 配置,用量会优先遵循该域,而不是提供程序 配置的域。COPILOT_GITHUB_DOMAIN 仍然具有最高优先级。

记忆搜索嵌入

GitHub Copilot 还可以作为 记忆搜索 的嵌入提供程序。 如果你拥有 Copilot 订阅并已登录,OpenClaw 可以将其用于嵌入, 而无需单独的 API 密钥。

配置

显式设置 memory.search.provider 以使用 GitHub Copilot 嵌入。 如果存在 GitHub Token,OpenClaw 会从 Copilot API 发现可用的嵌入模型, 并自动选择最佳模型。

{
  memory: {
    search: {
      provider: "github-copilot",
      // Optional: override the auto-discovered model
      model: "text-embedding-3-small",
    },
  },
}

工作原理

  1. OpenClaw 解析你的 GitHub Token(来自环境变量或身份验证配置)。
  2. 验证 Copilot 访问权限并解析特定于账户的 API 端点。
  3. 查询 Copilot 的 /models 端点以发现可用的嵌入模型, 10 秒截止时间包括读取响应主体。
  4. 选择最佳模型(优先级顺序:text-embedding-3-small、 text-embedding-3-large、text-embedding-ada-002)。
  5. 向 Copilot 的 /embeddings 端点发送嵌入请求。

模型可用性取决于你的 GitHub 套餐。如果发现失败或没有 可用的嵌入模型,只有在你显式配置了其他提供程序时, OpenClaw 才会使用 memory.search.fallback。 否则,设置会报告错误,而不是静默选择其他提供程序。

模型选择

选择提供程序、模型引用和故障转移行为。

OAuth 和身份验证

身份验证详情和凭据复用规则。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw