用途
uw-help 是 Unwind 技能体系的入门指引,用于在任何逆向工程任务开始时,说明如何查找并使用 Unwind 的各项技能。Unwind 面向代码库逆向工程,产出完整、机器可读、带源码链接的文档,覆盖代码分析、服务映射与文档编写。
主要能力
Unwind 采用混合架构:确定性扫描器(@unwind/core,基于 tree-sitter)生成可验证的基准事实,包括文件清单、结构符号、导入图和初层归属;LLM 专家在此基础上补充语义重建文档(业务逻辑、契约、MUST/SHOULD/DON'T)。完整性由集合运算验证,而非直接断言。
核心流程技能包括:uw-start(入口,定位、检查前置条件、驱动流水线)、uw-scan(产出 architecture.md)、uw-analyze(编排分层分析)、uw-verify(每层 gaps.md 工作清单)、uw-complete(填补缺口并删除 gaps.md)、uw-plan(产出 REBUILD-PLAN.md)、uw-graph(生成 rebuild-graph.json)、uw-dashboard(启动交互式图谱面板)、uw-build(在目标技术栈执行重建并生成完整性图)、uw-build-layer(按切片、技术无关的构建器)、uw-refresh(增量更新,仅重新分析变动层)。
分层专家技能包括数据库、领域模型、服务层、API、消息、前端、基础设施,以及单元测试、集成测试、E2E 测试分析师,分别产出对应文档。
使用方式
首次使用时扫描器会自动构建(技能通过 ensure_unwind_core 执行 pnpm install && pnpm build);也可手动预构建:
pnpm install && pnpm build
快速开始:直接使用 unwind:uw-start(会定位、检查前置条件并以每个阶段设检查点的方式驱动整个流水线)。手动顺序为:uw-scan → 审阅 architecture.md → uw-analyze → uw-verify → uw-plan → uw-dashboard。代码变更后使用 uw-refresh,通过指纹检测变动,仅重新分析受影响层,变更的契约在图谱中标记为 stale / needs-recheck。验证步骤(manifest 与文档的确定性差异)已集成进 uw-analyze,也可单独运行以复查既有文档。
输出结构位于 docs/unwind/,包含 architecture.md、.cache/(scan-manifest.json、meta.json、changes.json、seeds/{layer}.json、coverage/{layer}.json)、rebuild-graph.json、layers/(各层以文件夹形式存放 index.md 与分节文件,便于增量写入)以及 REBUILD-PLAN.md。
分析原则
完整性:记录全部条目,数量来自扫描清单并经验证;清单播种:专家获得候选检查清单,需覆盖每一项,排除项需记录而非丢弃;锚点 ID 标题:如 ### name [MUST] <!-- id: ... -->,使覆盖率可机械校验;机器可读:使用真实代码、SQL、mermaid,而非 Markdown 重述;链接到源码:尽可能提供带行号的 GitHub 链接;不作评论:只陈述事实,不推测、不建议。
适用场景与限制
适用于需要系统化理解并重建遗留代码库、生成分层文档与服务映射的逆向工程任务。覆盖率的说明:100% 覆盖仅表示每个符号都被描述,并不代表被描述的行为值得复现;uw-grill 步骤负责提出该问题,并将业务问题写入 docs/unwind/questions/ 供能回答的人填写。符号提取支持 TypeScript/JavaScript、Python、Rust、Java、C#;其他语言仍有文件级完整覆盖(优雅降级);若无 Node/pnpm,Unwind 回退到纯 LLM 流程。