跳转到主要内容

使用 GitHub 集成

更新于今天

有关在您的账户中启用 GitHub 的更多信息,请参阅设置 Claude 集成

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

如何添加 GitHub 存储库

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

聊天

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

  • 从下拉菜单中选择"从 GitHub 添加":

  • 使用文件浏览器选择特定的文件和文件夹:

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

项目

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

  • 从下拉菜单中选择"GitHub":

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

  • 使用文件浏览器选择特定的文件和文件夹:

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

  • 您可以使用"同步"图标确保您使用的是代码库的最新版本:

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

连接到私有存储库

如果您看到下面的警告并输入了有效的 URL,这很可能意味着您正在尝试将 Claude 连接到私有存储库:

请访问我们的 GitHub App 链接,如果您是 GitHub 管理员,可以授予对存储库的访问权限,或向您的 GitHub 组织管理员发送请求。

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

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

最佳实践

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

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

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

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

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

常见问题

问:从 GitHub 检索哪些信息?

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

问:如果我的存储库在添加到项目后被更新会怎样?

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

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

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

问:如果我失去对存储库的访问权限会怎样?

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

注意:所有 Claude 集成目前处于测试阶段。

这是否解答了您的问题?