Git 集成概述

将您的 Git 仓库连接到 Archyl 可以启用 AI 驱动的架构发现，使您的文档与实际代码保持同步。

支持的提供商

Archyl 支持所有主流 Git 托管平台：

云提供商

提供商 OAuth 功能
GitHub 是 完整支持
GitLab 是 完整支持
Bitbucket 是 完整支持

自托管

提供商 认证方式 功能
GitHub Enterprise Token 完整支持
GitLab 自托管 Token 完整支持
Gitea Token 完整支持
Azure DevOps Token 完整支持

连接仓库

步骤 1：导航到项目设置

  1. 打开您的项目
  2. 点击"设置"
  3. 进入"仓库"选项卡

步骤 2：选择提供商

  1. 点击"连接仓库"
  2. 选择您的 Git 提供商
  3. 授权 Archyl（对于 OAuth 提供商）

步骤 3：选择仓库

  1. 浏览您可用的仓库
  2. 选择要连接的仓库
  3. 选择默认分支
  4. 点击"连接"

认证

OAuth（推荐）

对于 GitHub、GitLab 和 Bitbucket 云服务：

  1. 点击"通过 [提供商] 连接"
  2. 在弹出窗口中授权 Archyl
  3. 选择要授予访问权限的仓库

OAuth 令牌安全存储并自动刷新。

个人访问令牌

对于自托管或企业提供商：

  1. 在您的 Git 提供商中生成令牌
  2. 所需权限范围：repo（读取权限）
  3. 在 Archyl 中输入令牌

仓库访问

Archyl 读取的内容

在 AI 发现过程中，Archyl 读取：

  • 文件结构和名称
  • 源代码内容
  • 配置文件（package.json、go.mod 等）
  • README 文件

Archyl 从不访问的内容

  • 环境文件（.env）
  • 凭证或密钥
  • Git 历史
  • 其他分支（除非明确选择）

多仓库

将多个仓库连接到单个项目：

单体仓库

对于单体仓库，只需连接一次并指定路径：

/services/api
/services/web
/packages/shared

多仓库

对于独立的仓库：

  1. 连接每个仓库
  2. 映射到系统或容器
  3. 发现在所有仓库中运行

Webhook（即将推出）

推送时自动同步：

  • 代码变更时触发发现
  • 自动更新架构
  • 保持文档最新

故障排除

授权失败

  • 检查您的令牌是否具有所需权限
  • 确保 OAuth 应用已授权
  • 尝试重新连接

找不到仓库

  • 验证您有权访问该仓库
  • 检查仓库 URL
  • 确保分支存在

发现错误

  • 检查排除路径
  • 降低并发设置
  • 查看 AI 提供商限制