文档
了解如何使用Archyl。
Getting started
C4 model
Features
- AI 驱动的发现 — 了解 Archyl 如何使用 AI 从您的代码库中自动发现和记录架构，并在每次推送时进行增量更新
- 架构变更请求 — 通过结构化的变更请求工作流提出、审查和合并对 C4 架构模型的变更
- 文档与 ADR — 在 Archyl 中创建和管理架构文档及架构决策记录
- 文档附件 — 通过拖放、粘贴或附件按钮将图片和文件上传到文档页面——安全存储在兼容 S3 的对象存储中
- 用户流程 — 记录跨架构的用户和数据流程，可视化交互序列
- 架构即代码 — 使用 archyl.yaml 定义和同步 C4 架构 — 版本控制、CI/CD 就绪、完全声明式
- 架构延时影片 — 把项目的版本历史重播成一部电影般的短片——元素自行绘出、已移除的服务被划掉、片尾字幕滚动——再导出为完全在浏览器中渲染的 1080p MP4
- 架构洞察 — 自动检测架构问题并获取改善系统设计的建议
- 分享与导出 — 与利益相关者分享架构图并导出为各种格式
- API 契约 — 记录和管理与 C4 架构元素直接关联的 API 规范
- 发布管理 — 通过 GitHub Actions、Webhook 和 REST API 的自动摄取，跨架构跟踪部署
- 市场集成 — 连接外部服务并在架构旁边显示实时指标、告警和仪表盘
- 生产现实（Living Diagram，动态图） — 连接 Kubernetes、Datadog、New Relic 等生产环境数据源，发现实时运行的服务及其依赖关系，再将它们与你的 C4 模型进行对账——只读、无破坏性
- 技术雷达 — 可视化您的技术全景，跟踪采用水平，并管理所有项目的技术栈
- Webhook 通知 — 当架构变更发生时，实时接收 HTTP 通知
- Slack 和 Teams 机器人 — 在 Slack 或 Microsoft Teams 中向 Archyl 询问你的架构，并让它使用实时 MCP 工具来回答和操作
- 所有权地图 — 通过交互式气泡、依赖关系线和覆盖率跟踪，可视化团队和用户在架构中的所有权
- 合规规则（护栏） — 定义确定性的架构规则，根据您的 C4 模型、技术决策和编码标准验证代码变更——全程不涉及 AI
- GitHub Actions 集成 — 使用 Archyl 官方 GitHub Actions，在 CI/CD 管道中运行架构合规检查、漂移评分、上下文生成等任务
- 合规规则包 — 面向常见架构模式的预置合规规则集——微服务、整洁架构、事件驱动、API 优先和安全基线
- 托管 Agent 运行 — 调度自主 AI Agent，按计划运行，通过 MCP 连接器接入外部服务，并在完整架构上下文中对代码库执行任务
- 自带 AI 提供商 — 通过您自己的提供商(OpenAI、Anthropic、Google Gemini、AWS Bedrock 或任何 OpenAI 兼容端点)使用您自己的凭据路由所有 Archyl AI 功能 — 并跳过 Archyl 配额限制。
Guides
- 创建您的第一个项目 — 在 Archyl 中创建和记录您的第一个架构项目的分步指南
- 嵌入图表 — 将交互式 Archyl 图表嵌入到 Confluence、Notion、Miro 及其他平台
- 安全性 — 了解 Archyl 如何保护您的数据和架构信息
- 设置与配置 — 配置 AI 提供商、管理订阅，并自定义您的 Archyl 体验
- 编程代理技能 — 安装并使用 Archyl 的 11 个编程代理技能，直接在 Claude Code、Codex 或任何兼容的代理中验证、记录、审查和优化您的架构
- Archyl Harness — 五分钟让任何编程代理理解您的架构：精准上下文、受管控的工作会话、Guardrails 强制执行，以及在代理之间不断累积的记忆
Git integration
- Git 集成概述 — 连接您的 Git 仓库以启用 AI 驱动的架构发现