流程總覽
| 步驟 | 發生什麼事 |
|---|---|
| Generate(生成) | 代理從你的描述寫出型別化 JSON IR |
| Validate(驗證) | 內建驗證器與版面規則檢查原始檔;失敗給出精確的局部修復(機器可讀 JSON) |
| Preview(預覽,可選) | loopback-only 桌面模式監看單一 JSON 檔,只在最新候選全過後才重新整理;失敗時保留上一個驗證過的圖 |
| Deliver(交付) | 同目錄候選渲染並檢查;只有通過的產物才原子取代目標檔,可選 --open 開啟該確切檔案 |
| Iterate(迭代) | 代理更新原始檔,無關結構保持穩定 |
常用 repo 指令:1
cd archify
node bin/archify.mjs doctor
node bin/archify.mjs demo /tmp/archify-demo
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
快速撰寫路徑(Fast authoring path)
- 依問題選
architecture、workflow、sequence、dataflow、lifecycle。 - 讀撰寫預設與該模式範例(與完整 schema 分開批次讀,避免截斷);讀相關 schema 定義後再選新欄位;範例教形狀不教事實,直接寫完整候選,不做臨時圖或路徑探測。
- 寫完整候選 JSON:先定抽象與連接式版面(主旅程與必要分支、控制角色、行為改變條件),自動路由優先,只在必要分支/回傳/給定幾何/量測修復時加顯式路由;
meta.quality_profile預設"showcase"。 - 直接跑
finalize(首閘即 showcase validation,成功的首稿不需單獨預驗證):2
node bin/archify.mjs finalize <type> <candidate.json> <output.html> --quality showcase --json
repo-backed 候選首稿就帶證據:
node bin/archify.mjs finalize <type> <candidate.json> <output.html> --repo-root <repo-root> --quality showcase --json
- 非零結束永遠不是成功。讀 compact stdout 或
evidence.summaryReceipt,按失敗閘門修復(限兩輪修正內),保留請求語意與來源證據,改連接鄰域後重跑完整finalize。
輸出資料夾慣例
除非使用者指定位置,每個新圖請求在工作目錄下獨立資料夾:2
.archify/<type>-<slug>-<YYYYMMDD-HHMMSS>/candidate.json
.archify/<type>-<slug>-<YYYYMMDD-HHMMSS>/<slug>.html
meta.output 設為該相對 HTML 路徑;修復重跑重用同資料夾,後續請求開新資料夾,舊版保持完整。
設定
{
"meta": {
"locale": "en",
"animation": "trace",
"visual_preset": "signal-flow"
}
}
meta.locale 只本地化頁面標題、圖例、狀態/錯誤、無障礙與 HTML/SVG lang——不翻譯你撰寫的內容。en/zh-CN 內建;其他語言(含 es)需 meta.translations(見 examples/locales/es.json),否則退回英文並揭露。靜態輸出省略 animation;classic 為預設。1