这份详细的部署教程将指引您安装和使用 Archify——一个专为 AI 编程助手设计的技能,能将您的代码库或系统描述,转化为精美的、可交互的架构图、流程图、时序图等。

Archify 的核心价值在于,它不只生成静态图片,而是生成一个自包含的 HTML 文件。这个文件包含了可交互的图表、搜索、聚焦、路径追踪、主题切换等功能,非常适合用于文档、代码审查或演示。它通过让 AI 生成结构化的 JSON 数据,再确定性(deterministically)地渲染为图表,确保了输出的一致性和可验证性。

整个部署流程非常简单,您只需通过 npx skills 命令安装,然后在聊天中向 AI 助手提出绘图需求即可。

📥 安装

Archify 是一个 Agent Skill,可以通过社区通用的 skills 工具安装,适用于 Cursor、Claude Code、Codex CLI 和 OpenCode 等主流 AI 编程助手。

1
2
3
4
5
# 全局安装 (推荐,所有项目可用)
npx skills add tt-a1i/archify -g

# 如果您使用 Cursor,并希望显式安装到 Cursor,可以用这个命令
npx -y skills add tt-a1i/archify --skill archify --agent cursor --global --copy --yes

其他安装方式

  • Claude Code / Codex / OpenCode:通过上述 npx skills 命令安装后,技能会被放置到对应工具的全局或项目技能目录(如 ~/.claude/skills/)。
  • Raven:从 Releases 下载 archify.zip,手动解压到 ~/.raven/workspace/skills/ 目录下。
  • Claude.ai (网页版):下载 archify.zip,然后在 Settings → Capabilities → Skills 中上传。

🚀 使用方式

安装完成后,您可以直接在 AI 助手的聊天中,用自然语言描述您想要的图表。

基本用法

向您的 AI 助手发送类似以下的指令:

1
Use archify to map this repository's runtime architecture.

或更具体地:

1
Analyze this repository, then use archify to create a high-level runtime architecture diagram. Show 8–12 core components, one primary path, external dependencies, and trust boundaries. Put supporting detail in cards instead of adding more edges.

绘制特定流程

您也可以为特定功能绘制图表:

1
Use archify to draw this login flow: Browser -> Web App -> API -> JWT validation -> Redis session lookup -> PostgreSQL fallback. Keep the cache-miss path secondary.

迭代与完善

在 AI 生成初稿后,您可以通过对话提出修改:

1
2
3
add Redis
move auth to the left
highlight the rollback path

AI 会更新 JSON 源数据,并重新生成图表。

🎨 图表类型与选择

Archify 支持五种图表类型,您可以根据需求在指令中指明:

图表类型 最佳用途 提示词示例
Architecture (架构图) 展示组件、服务、存储和边界。 “Create an architecture diagram for…”
Workflow (工作流图) 展示 CI/CD、审批、工具调用等流程。 “Draw the CI/CD workflow with approvals.”
Sequence (时序图) 展示 API 调用、缓存回退、认证等交互。 “Show the API call with Redis cache miss.”
Data Flow (数据流图) 展示数据管道、血缘、PII 处理等。 “Map the data pipeline from source to consumers.”
Lifecycle (生命周期图) 展示状态、重试、等待和终止状态。 “Illustrate the job lifecycle with retries.”

🔍 探索与分享图表

Archify 生成的 HTML 文件自带强大的交互功能,方便您和团队协作。

  • 打开图表指南:在生成的 HTML 页面中按 ? 键。
  • 搜索和聚焦:按 / 键搜索并聚焦一个节点。
  • 追踪依赖:聚焦一个节点后,可以使用 Upstream / Downstream 查看其上游或下游的依赖。
  • 导出:点击 Export 菜单,可以复制 PNG 到剪贴板,或下载 PNG、SVG、WebM 以及用于分享的卡片图。

⚙️ 工作原理 (简单来说)

  1. AI 生成 JSON:您的 AI 助手会根据您的描述和代码分析,生成一份结构化的 JSON 文件,它描述了图表的节点、关系和样式。
  2. Archify 验证与渲染:Archify 内置的验证器会检查 JSON 的正确性。通过后,它会将 JSON 确定性地编译成一个自包含的 HTML 文件。
  3. 交付与迭代:您得到 HTML 文件,可以随时查看、分享,并可以在聊天中继续提出修改意见。