跳转到主要内容

使用 GitHub 集成

有关在您的账户中启用 GitHub 的更多信息,请参阅 使用连接器扩展 Claude 的功能

将您的 GitHub 存储库直接连接到 Claude,为您的软件开发任务提供全面的上下文。您可以通过从列表中选择存储库来轻松添加存储库,帮助 Claude 更好地理解和协助您的代码库。

如何添加 GitHub 存储库

注意: 如果您当前未通过 GitHub 身份验证,您将被重定向到 GitHub 进行身份验证,然后才能使用此集成。

聊天

  1. 点击聊天界面左下角的 "+" 按钮。

  2. 从下拉菜单中选择 "从 GitHub 添加"。

  3. 使用文件浏览器选择特定的文件和文件夹。

  4. 当您发送消息时,Claude 将访问并处理内容以告知其响应。

项目

  1. 点击您的项目知识部分右上角的 "+" 按钮。

  2. 从下拉菜单中选择 "GitHub"。

  3. 搜索您可访问的存储库,或粘贴存储库 URL。

  4. 使用文件浏览器选择特定的文件和文件夹。

  5. 您选择的内容将被添加到项目知识中,供 Claude 访问和处理。

  6. 您可以使用 "同步" 图标来确保您使用的是代码库的最新版本。

  7. 您可以使用 "配置文件" 图标来修改 Claude 分析的文件和文件夹。

连接到私有存储库

  • 如果 Claude 在您输入有效 URL 后无法访问存储库,这很可能意味着您正在尝试将 Claude 连接到私有存储库:请访问我们的 GitHub App 链接,如果您是 GitHub 管理员,可以授予对存储库的访问权限,或向您的 GitHub 组织管理员发送请求。

  • 如果可以,请自行授予访问权限:您可以选择让 Claude 访问所有存储库或特定存储库。

  • 如果您没有必要的权限,请请求访问权限:您的 GitHub 组织管理员将收到有关您的请求的电子邮件通知。一旦他们批准请求,您将能够在 Claude 中同步和访问存储库。


最佳实践

  1. 从小处开始:首先选择代码库的一个小子集进行分析。这将帮助您熟悉 Claude 如何解释和讨论您的代码。

  2. 迭代和改进:如果 Claude 的初始响应没有完全解决您的问题,请不要犹豫,提出后续问题或请求澄清。

  3. 结合人类专业知识:使用 Claude 的见解作为进一步调查和与您的团队讨论的起点。请审查 Claude 的工作。

  4. 深思熟虑的文件选择:使用 "配置文件" 时,要战略性地进行选择。包括对您当前任务或项目至关重要的关键文件和目录,但避免选择不必要的文件以保持在令牌限制内并保持专注。

  5. 定期更新:记住定期刷新您的项目的 GitHub 同步,以确保 Claude 使用的是代码库的最新版本,特别是在开始新分析之前或当您知道存储库有重大更改时。


故障排除

连接后组织中的存储库未出现

如果您的 GitHub 连接显示为已连接,但来自特定组织的私有存储库未出现,该组织可能需要单点登录 (SSO)。当需要 SSO 时,每个用户必须分别为该组织授权 Claude 应用。在您这样做之前,GitHub 会从您的视图中过滤该组织的私有存储库,即使您的连接在其他方面正常工作。

当 Claude 检测到此状态时,存储库选择器会显示一个横幅,提示您授权 SSO。要为您的组织授权 Claude 应用:

  1. 转到 github.com/settings/applications 并打开 Claude 条目。

  2. 组织访问 下,点击相关 GitHub 组织旁边的 "授予"。

  3. 如果按钮显示 "请求" 而不是 "授予",您没有权限自行授权应用。GitHub 组织管理员必须从组织的 OAuth 应用策略设置中批准您的请求。

重要:在您的 Claude 设置中断开连接并重新连接 GitHub 不会解决此问题。新连接不会自动授权需要 SSO 的组织,因此您需要完成上述授权步骤。

如果您的组织使用带有企业托管用户 (EMU) 的 GitHub Enterprise Cloud,Claude 应用也必须在企业级别获得批准。在 为 Claude Code 设置代码审查 中了解更多信息。


常见问题

从 GitHub 检索了哪些信息?

仅同步存储库中特定分支上的文件(名称和内容)。我们不检索提交历史、PR 或其他元数据。

将存储库添加到项目后,如果我的存储库被更新会发生什么?

您可以点击 "立即同步" 来从您的存储库获取最新更改。这将更新所有之前选择的文件和文件夹。

我可以将多个存储库添加到单个项目或聊天吗?

是的,您可以添加多个存储库,为您的开发任务为 Claude 提供全面的上下文。存储库必须符合 Claude 的上下文窗口。

如果我失去对存储库的访问权限会发生什么?

如果您失去对存储库的访问权限,您将无法在之前添加它的项目中查看其内容。存储库预览将被删除,但对话历史将被保留。

连接器目录 中浏览所有可用的连接器。

这是否解答了您的问题?