- 📌Skill基础信息
- Skill名称:C4架构文档生成器
- 简称:c4-architecture
- 来源:社区第三方(eery1677-lab/Antigravity-Awesome-Skills)
- 运行宿主:仅限支持
skills install命令的 Agent 工具(具体宿主未明确,需参考原始仓库说明) - 核心定位:通过自底向上分析代码库,自动生成符合 C4 模型的完整架构文档(Context/Container/Component/Code 四级),适用于中大型项目架构可视化。
- 🧩内部核心组成
- 子Agent集合:
- c4-code:代码级分析
- c4-component:组件合成
- c4-container:容器映射
- c4-context:上下文生成
- 工作阶段:
| 阶段 | 输出文件 | 关键动作 |
|---|---|---|
| 代码级 | c4-code-*.md | 扫描目录→生成函数/类文档 |
| 组件级 | c4-component-*.md | 聚合代码→定义逻辑组件 |
| 容器级 | c4-container.md | 关联部署配置→生成API规范 |
| 上下文级 | c4-context.md | 整合用户旅程→绘制系统上下文图 |
- 输出目录:自动创建
C4-Documentation/存放所有文档
- 🛠安装与启用方式
- 安装命令:
```bash
skills install --user eery1677-lab/Antigravity-Awesome-Skills
```
- 前置依赖:需具备代码库访问权限(本地或远程仓库)
- 启动方式:通过 Agent 工具调用技能后,自动触发四阶段分析流程
- 📋标准工作流
- 用户输入:指定目标代码库路径
- 阶段1(代码级):
- 深度优先扫描目录,排除 node_modules/.git 等非代码目录
- 为每个代码目录生成函数/类签名、依赖关系的 Markdown
- 阶段2(组件级):
- 根据领域边界聚合代码文档,定义组件接口和Mermaid关系图
- 阶段3(容器级):
- 结合 Dockerfile/K8s 等部署配置,生成 OpenAPI 规范
- 阶段4(上下文级):
- 提取用户角色、外部系统依赖,输出非技术人员可理解的上下文图
- ⚠️关键限制、缺陷、注意事项
- 平台限制:
- 仅适用于结构化代码库(如微服务/单体应用),不适合无明确目录结构的脚本
- 资源消耗:
- 大型代码库可能导致长时间分析(需注意Token消耗)
- 已知缺陷:
- 依赖部署配置文件(若无 Dockerfile 等,容器级文档可能不完整)
- 生产建议:
- 建议在开发环境先验证输出准确性,再用于正式文档
- ✅适用场景 & ❌不适合场景
- ✅ 适用:
- 微服务架构的技术文档自动化
- 新成员快速理解系统拓扑
- 遗留系统重构前的架构梳理
- ❌ 不适用:
- 小型脚本项目(过度文档化)
- 无明确代码分层的仓库
- 需要实时架构图同步的场景(非持续集成设计)
如何安装
skills install --user eery1677-lab/Antigravity-Awesome-Skills通用安装教程:在哪里输入上面的命令
上面的命令本质是在「终端 / 命令行」中调用技能管理器,把该 Skill 下载并注册到你的 AI 工具。各主流工具打开终端的位置不同,按下面操作即可:
- 打开工具自带的终端面板,或系统终端(macOS「终端」、Windows「PowerShell」、Linux「Terminal」)。
- 把上面的安装命令复制进去,回车运行,等待下载与注册完成。
- 重启或重新加载 AI 工具,让新安装的 Skill 被识别。
- 新建对话并触发:直接描述用途,或通过该工具的技能 / 斜杠菜单选中此 Skill。
Claude 桌面版(macOS / Windows)
桌面版没有内置命令行,Skill 需通过 Claude Code CLI 安装。打开系统终端,先执行 npm install -g @anthropic-ai/claude-code,再运行上面的安装命令;完成后完全退出并重新打开 Claude。
Claude Code(终端 CLI)
直接在项目目录的终端里运行上面的命令即可。也可先输入 claude 启动交互界面,再在对话中引用该 Skill(/ 斜杠菜单或直接描述用途)。
VS Code(含 GitHub Copilot)
打开终端面板:菜单「终端 → 新建终端」,或快捷键 Ctrl+`(macOS 为 ⌃+`)。在终端里运行上面的命令;装完后执行「重新加载窗口」(Ctrl+Shift+P → Reload Window),让 Copilot 等扩展识别新技能。
Cursor
底部「终端」面板(Ctrl+`)即是内置终端。粘贴运行上面的命令,完成后在命令面板执行「Reload Window」刷新,再开始对话。
Windsurf
底部「终端」面板运行命令;也可直接使用其内置 Agent 终端,在对话侧执行安装。
其他工具(ChatGPT、本地脚本等)
不支持本地终端的产品,可先在本机终端完成安装,再在对话中描述该 Skill 的能力让其调用;不同工具的命令格式请以其官方文档为准。
风险提示
自动扫描未发现高危命令、隐私抓取或数据外传行为。仍建议安装前快速浏览仓库代码。
Aitishiku.com