调试你的 GitHub Copilot 扩展 - GitHub 文档

注意

GitHub Copilot 扩展处于公开预览阶段，可能会发生变化。

使用 Copilot 扩展的调试工具，您可以从命令行与 Copilot 代理聊天，然后在代理生成响应时查看详细日志。您可以向该工具传递多个标志，其中最重要的标志是

url 标志，其中包含访问 Copilot 代理的 URL。这是启动工具的唯一必需标志。
log-level 标志，它确定您对 Copilot 代理生成响应过程的可见性级别。可用的日志级别为 DEBUG、NONE 和 TRACE，工具默认使用 DEBUG。
token 标志，如果您的 Copilot 代理调用 Copilot LLM，则此标志必须包含具有对 Copilot 聊天的读取访问权限的细粒度个人访问令牌。如果您的代理调用不同的 LLM，则不需要使用此标志。

先决条件

要使用调试工具，您需要在您的机器上安装 GitHub CLI。您可以通过以下两种方式之一安装 GitHub CLI

可选地，要准备调试特定的服务器发送事件 (SSE)，请向您的 Copilot 代理添加一些代码，当提示包含某个特定关键字时发送 SSE。

注意

调试工具不处理有效负载验证过程。要验证您的 SSE，您需要暂时禁用本地测试的有效负载验证，然后在成功测试扩展后重新启用它。
在命令行中，启动您的 Copilot 代理。
要使用 GitHub CLI OAuth 应用进行身份验证，请在新命令行应用程序窗口中粘贴以下命令并按照提示操作
Bash
```
gh auth login --web -h github.com
```
```
gh auth login --web -h github.com
```

在同一窗口中，要安装调试工具，请粘贴以下命令

Bash

gh extension install github.com/copilot-extensions/gh-debug-cli

gh extension install github.com/copilot-extensions/gh-debug-cli

可选地，要获取可用标志及其描述的列表，请将以下命令粘贴到命令行中
Bash
```
gh debug-cli -h
```
```
gh debug-cli -h
```
可选地，为要使用的每个标志设置环境变量。环境变量允许您为标志设置一个常量值，而不是每次运行调试工具时都传递一个值。例如，如果您正在使用 Blackbeard 扩展测试调试工具，则可以为代理 URL 创建一个环境变量，如下所示
Bash
```
export URL="https://127.0.0.1:3000"
```
```
export URL="https://127.0.0.1:3000"
```
注意

要为标志设置环境变量，必须使用该标志的全大写名称。
要启动调试工具，请将以下命令粘贴到命令行中，并添加要使用的任何标志
Bash
```
gh debug-cli
```
```
gh debug-cli
```
唯一必需的标志是 url 标志，但您可能希望使用其他标志，例如 log-level 和 token。

调试工具运行后，您应该会看到一条消息，内容为“开始键入以与您的助手聊天…”。
要与您的代理交互，请在命令行中输入提示。输出将根据您在上一步中选择的日志级别而有所不同，DEBUG 和 TRACE 日志级别将提供更详细的信息。

提示

如果您正在调试 SSE，请发送包含您在 Copilot 代理中指定的关键字的提示以触发 SSE，然后在您的命令行应用程序中分析输出。