首页 / 开源热榜 / archify / 使用教程

Archify 教程:从描述到经过验证的交互式架构图

更新于 2026-09-23 · NGJOO AI 实验室 · 约 9 分钟

Archify 不是在线画板。它是一项供编码代理调用的 skill:代理先写类型化 JSON,仓库里的规则检查节点、连线和版面,再输出一个可离线打开的交互式 HTML。当前覆盖架构、工作流、时序、数据流和生命周期五类图。

最新稳定版是 v2.16.0,发布于 2026-08-30。官方 README 顶部的 v2.17.0-dev.1 是 main 分支开发版本,不要把它当作稳定 release。

1. 先理解生成链路

一次完整流程是:描述目标或提供仓库证据,代理选择图类型并写 JSON,验证器检查 schema 与质量规则,渲染器生成自包含 HTML,最后才交付正式文件。图中的关系仍来自代理写入的事实。验证器不会连接真实基础设施,也不会判断一项代码修改是否安全。

官方 README建议首张架构图只放 8 至 12 个核心组件、一条主路径、外部依赖和信任边界。细节放说明卡片,通常比继续加线更容易读。

2. 安装和最小试用

全局安装使用:

npx skills add tt-a1i/archify -g

只想在 Codex 中临时试用,可运行:

npx skills use tt-a1i/archify@archify --agent codex

然后给出一个有明确方向的请求,例如:

Use Archify to draw: Browser -> API -> Redis cache -> PostgreSQL fallback.

这个例子不需要代码仓库。如果要求它描述已有系统,应先打开仓库,并让代理给每个重要组件和边提供源码依据。

3. 从源码使用验证与交付命令

官方仓库提供零依赖 Node CLI。克隆仓库后,可以按下面的顺序理解流程:

node bin/archify.mjs doctor
node bin/archify.mjs guide "Show CI/CD checks, approval, deploy, and rollback"
node bin/archify.mjs validate workflow examples/agent-tool-call.workflow.json --quality showcase --json
node bin/archify.mjs preview workflow examples/agent-tool-call.workflow.json /tmp/workflow.html --quality showcase
node bin/archify.mjs deliver workflow examples/agent-tool-call.workflow.json /tmp/workflow.html --quality showcase --open --json

preview 用来查看候选,deliver 才写正式目标。官方说明 deliver 会先生成同目录候选并验证,通过后原子替换目标。这能防止半成品覆盖现有图,但不能替你确认业务事实。

4. 输出和边界

查看器支持明暗主题、节点搜索、路径和上下游关系追踪,也能导出 PNG、SVG、WebM 及 1200×630 分享卡片。Architecture Delta 可以对照 Before、Delta 和 After 三份已验证数据;它只显示作者写入的变化,不会推断线上影响、风险或是否可合并。

当前明确不支持自动解析 Mermaid,也不是通用自动布局器;项目没有托管分享平台和所见即所得编辑器。布局质量仍取决于代理的结构选择和你的复核。

5. 更新检查与商业化判断

Archify 可请求固定的稳定版 manifest 来提示更新,不自动下载或安装。官方说明请求不携带版本、代理、项目数据、提示词、账号、设备 ID 或 ETag;服务器仍能看到常规的 IP 和时间。要完全关闭请求和本地提醒状态写入,设置:

export ARCHIFY_UPDATE_CHECK_DISABLED=1

仓库以 MIT 发布,安装和生成流程没有充值、订阅配额分发或付费下载。

验证边界:本轮只核对官方 README、CHANGELOG 和 v2.16.0 release。没有执行 npx 安装,没有运行 doctor、demo、validate、preview 或 deliver,也没有实际生成和导出图表;结论属于 docs-only。

6. 与 Mermaid 对比

Mermaid用接近 Markdown 的文本语法渲染 20 多种图,源码短,适合版本控制,并能在 GitHub Markdown 里直接显示。Archify 使用代理生成的类型化 JSON,把 schema 验证、交互式查看器和验证后交付串起来。

README 里的一张简单流程图,Mermaid 往往更直接。若团队需要追踪路径、切换视图、导出分享卡片,并希望代理产图先经过结构检查,再评估 Archify。

这里仅补原教程没有展开的事实和边界。安装命令与操作步骤仍以前文为准。

先判断这个项目是否适合你

适合谁用

适合把系统组件、CI/CD 审批、API 调用、数据血缘或重试状态整理成可审查的交互图。第一次应限制在 8 到 12 个核心组件和一条主路径,核对节点与连线后再补边界、异常和说明卡片;复杂仓库若没有可靠证据,不应让代理凭名称补全架构。

采用建议

Archify 更适合需要把代理产图纳入验证和交付流程的团队。先从小图开始,保留 JSON 源文件并核对每条边;若目标只是 README 里的一张简单图,Mermaid 通常更省步骤。

原教程未展开的系统信息

核心功能

  • 类型化图数据

    代理先写 architecture、workflow、sequence、data-flow 或 lifecycle 对应的 JSON;schema 与验证器检查节点、边、路径和版面约束,再生成 HTML。

  • 交互式单文件输出

    生成的 HTML 可切换明暗主题、搜索节点、追踪路径与上下游关系,并导出 PNG、SVG、WebM 或分享卡片。

常见问题

Archify 现在应该使用 2.16.0 还是 2.17.0-dev.1?

2.16.0 是截至 2026-09-23 的最新稳定 release;2.17.0-dev.1 是 main 分支开发版本。

使用 Archify 必须先打开代码仓库吗?

不必。仅凭描述也能生成图;涉及真实系统时,应打开仓库并要求代理引用源码证据。

Archify 能把现有 Mermaid 图自动导入吗?

不能。官方明确把 automatic Mermaid parsing 列为当前不支持的能力,需要重建成类型化 JSON。

Archify 的更新检查会上传项目或提示词吗?

官方说明不会上传项目数据或提示词。可设置 ARCHIFY_UPDATE_CHECK_DISABLED=1 关闭检查。