duyanta123/arch-doc

插件 ⭐ 0 MIT other

分析代码库并生成架构文档(模块职责、依赖关系、入口点、运行方法)。

catalog 简介:Analyze a codebase and generate architecture documentation (module responsibilities, dependencies, entry points, run methods).

安装

## 使用

1. 安装:`dsh plugin --profile web add github:duyanta123/arch-doc#v0.1.1`
2. 使用:对 Agent 说「用 arch-doc 分析 /path/to/repo」
3. 本地开发:profile 的 package.json 加 `"arch-doc": "file:<本地路径>/arch-doc"`,bundles 加 `"arch-doc"`

## 输出

- `docs/ARCHITECTURE.md`:结构化架构文档(按 `docs/architecture-template.md` 骨架)
- `docs/architecture.json`:机器可读的结构化结果
- `docs/diagrams/module-dependencies.mmd`:Mermaid 模块依赖图

## 环境要求

- Node.js >= 18(运行 `scripts/arch-profile.mjs`;无 Node 时 runbook 自动降级为 shell 手工探测)

## 脚本

duyanta123/arch-doc 加入你的 DSH 配置(web profile)即可启用。

README

展开完整 README 收起

README 内容为空。