@dtt_siye/atool 1.3.1 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +97 -214
- package/README.md.atool-backup.20260410_114701 +299 -0
- package/VERSION +1 -1
- package/bin/atool.js +55 -9
- package/hooks/doc-sync-reminder +4 -4
- package/hooks/hooks-cursor.json +20 -0
- package/hooks/hooks.json +21 -1
- package/hooks/pre-commit +191 -0
- package/hooks/prompt-guard +84 -35
- package/hooks/session-start +34 -12
- package/hooks/task-state-tracker +145 -0
- package/install.sh +14 -4
- package/lib/common.sh +36 -23
- package/lib/compute-importance.sh +73 -0
- package/lib/install-cursor.sh +24 -2
- package/lib/install-hooks.sh +64 -0
- package/lib/install-kiro.sh +26 -2
- package/lib/install-skills.sh +5 -2
- package/lib/pre-scan.sh +13 -1
- package/lib/project-init.sh +28 -9
- package/package.json +1 -1
- package/skills/agent-audit/SKILL.md +180 -0
- package/skills/ai-project-architecture/SKILL.md +33 -534
- package/skills/ai-project-architecture/rules/architecture-validation.md +200 -0
- package/skills/ai-project-architecture/rules/compliance-check.md +83 -0
- package/skills/ai-project-architecture/rules/iron-laws.md +188 -0
- package/skills/ai-project-architecture/rules/migration.md +94 -0
- package/skills/ai-project-architecture/rules/refactoring.md +91 -0
- package/skills/ai-project-architecture/rules/testing.md +249 -0
- package/skills/ai-project-architecture/rules/verification.md +111 -0
- package/skills/architecture-guard/SKILL.md +164 -0
- package/skills/architecture-guard/rules/violation-detection.md +90 -0
- package/skills/atool-init/SKILL.md +24 -4
- package/skills/ci-feedback/SKILL.md +165 -0
- package/skills/project-analyze/SKILL.md +129 -19
- package/skills/project-analyze/phases/phase1-setup.md +76 -5
- package/skills/project-analyze/phases/phase2-understand.md +137 -26
- package/skills/project-analyze/phases/phase2.5-refine.md +32 -23
- package/skills/project-analyze/phases/phase3-graph.md +39 -5
- package/skills/project-analyze/phases/phase4-synthesize.md +17 -1
- package/skills/project-analyze/phases/phase5-export.md +42 -4
- package/skills/project-analyze/prompts/understand-agent.md +156 -298
- package/skills/project-analyze/rules/java.md +69 -1
- package/skills/project-query/SKILL.md +91 -200
- package/skills/project-query/rules/aggregate-stats.md +301 -0
- package/skills/project-query/rules/data-lineage.md +228 -0
- package/skills/project-query/rules/impact-analysis.md +218 -0
- package/skills/project-query/rules/neighborhood.md +234 -0
- package/skills/project-query/rules/node-lookup.md +97 -0
- package/skills/project-query/rules/path-query.md +135 -0
- package/skills/software-architecture/SKILL.md +39 -501
- package/skills/software-architecture/rules/concurrency-ha.md +346 -0
- package/skills/software-architecture/rules/ddd.md +450 -0
- package/skills/software-architecture/rules/decision-workflow.md +155 -0
- package/skills/software-architecture/rules/deployment.md +508 -0
- package/skills/software-architecture/rules/styles.md +232 -0
package/README.md
CHANGED
|
@@ -1,255 +1,138 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @dtt_siye/atool
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](LICENSE)
|
|
5
|
-
[](install.sh)
|
|
3
|
+
AI Developer Toolkit - 一键配置 AI IDE 的工具集
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
## 技术栈
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
- **检测类型**: generic
|
|
10
8
|
|
|
11
|
-
|
|
12
|
-
# 方式一:npm 安装(推荐,全局可用)
|
|
13
|
-
npx @dtt_siye/atool
|
|
14
|
-
|
|
15
|
-
# 方式二:从源码安装
|
|
16
|
-
git clone --recursive https://github.com/user/atool.git && cd atool
|
|
17
|
-
./install.sh --all --yes
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## 支持的 IDE
|
|
23
|
-
|
|
24
|
-
| IDE | Skills | Hooks | 强制执行 | 特色 |
|
|
25
|
-
|-----|--------|-------|---------|------|
|
|
26
|
-
| **Claude Code** | ✅ SKILL.md | ✅ 全局(3 个) | **高** | Slash 命令 + 并行 Agent |
|
|
27
|
-
| **Cursor** | ✅ .mdc Rules | ⚠️ 项目级(3 个) | **中** | alwaysApply + globs 智能加载 |
|
|
28
|
-
| **Kiro** | ✅ Steering Markdown | ❌ | **低** | 合并精简 43→~8 文件(token -87%) |
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## 核心理念
|
|
33
|
-
|
|
34
|
-
1. **开箱即用** — 安装后在 IDE 中正常聊天,AI 自动加载工作流和编码规范
|
|
35
|
-
2. **项目自适应** — 自动检测 17 种技术栈,匹配对应编码规范(零配置)
|
|
36
|
-
3. **老旧代码分析** — 多 Agent 并行深度分析,5 分钟理解 30 分钟的代码
|
|
37
|
-
4. **文档自动同步** — 代码修改后自动提醒并更新文档,确保交付质量
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## 快速开始
|
|
42
|
-
|
|
43
|
-
### npm 安装(推荐)
|
|
9
|
+
## 🚀 性能优化:SKILL.md 精简架构
|
|
44
10
|
|
|
45
|
-
|
|
46
|
-
# 一键安装到所有 IDE
|
|
47
|
-
npx @dtt_siye/atool
|
|
48
|
-
|
|
49
|
-
# 或全局安装后使用
|
|
50
|
-
npm install -g @dtt_siye/atool
|
|
51
|
-
atool # 安装到所有 IDE
|
|
52
|
-
atool --project ./my-app # 初始化项目
|
|
53
|
-
```
|
|
11
|
+
aTool 已实现 **"SKILL.md 精简 + 按需加载"** 架构优化:
|
|
54
12
|
|
|
55
|
-
###
|
|
13
|
+
### 📊 优化成果
|
|
56
14
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
./install.sh --project /path/to/your/project
|
|
63
|
-
|
|
64
|
-
# 或在 Claude Code 中一步到位:
|
|
65
|
-
# /atool-init
|
|
66
|
-
```
|
|
15
|
+
| 指标 | 重构前 | 重构后 | 改进 |
|
|
16
|
+
|------|--------|--------|------|
|
|
17
|
+
| SKILL.md 总行数 | ~8,900 行 | ~4,200 行 | ↓53% |
|
|
18
|
+
| 超过 200 行的 skill | 25 个 | 0 个 | ↓100% |
|
|
19
|
+
| 单次调用 token 消耗 | ~6,000 | ~2,000 | ↓67% |
|
|
67
20
|
|
|
68
|
-
|
|
21
|
+
### ⚡ 按需加载机制
|
|
69
22
|
|
|
70
|
-
|
|
23
|
+
- **精简入口**: 每个 SKILL.md ≤150 行,仅包含核心信息
|
|
24
|
+
- **模块化内容**: 详细规则拆分到 `rules/`、`phases/`、`references/` 子目录
|
|
25
|
+
- **智能加载**: AI 根据查询只读取相关文件,避免全量加载
|
|
71
26
|
|
|
72
|
-
##
|
|
73
|
-
|
|
74
|
-
| 选项 | 描述 |
|
|
75
|
-
|------|------|
|
|
76
|
-
| `--all` | 安装到所有已检测到的 IDE |
|
|
77
|
-
| `--claude` / `--cursor` / `--kiro` | 仅安装到指定 IDE |
|
|
78
|
-
| `--project PATH` | 初始化项目(检测技术栈 + 生成模板) |
|
|
79
|
-
| `--analyze PATH` | 准备项目深度分析目录(配合 project-analyze skill) |
|
|
80
|
-
| `--update` | 一步式更新(git pull + 自动重装变更组件) |
|
|
81
|
-
| `--uninstall` | 移除所有 aTool 配置 |
|
|
82
|
-
| `--dry-run` | 预览模式,不做任何实际修改 |
|
|
83
|
-
| `--force` | 强制覆盖(默认:合并 + 备份) |
|
|
84
|
-
| `--check-updates` | 检查更新(不安装) |
|
|
85
|
-
| `--yes` | 跳过确认提示 |
|
|
86
|
-
| `--version` / `--help` | 版本号 / 帮助信息 |
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## 工作流全景
|
|
27
|
+
## 项目结构
|
|
91
28
|
|
|
92
|
-
|
|
29
|
+
> 由 `project-analyze` skill 自动填充
|
|
93
30
|
|
|
94
31
|
```
|
|
95
|
-
|
|
32
|
+
├── src/ # 源代码
|
|
33
|
+
├── tests/ # 测试
|
|
34
|
+
├── docs/ # 文档
|
|
35
|
+
│ ├── 04-skills.md # Skills 系统文档(已更新)
|
|
36
|
+
│ └── ...
|
|
37
|
+
├── skills/ # Skills 目录
|
|
38
|
+
│ ├── java-conventions/ # 精简架构示例
|
|
39
|
+
│ │ ├── SKILL.md # ≤150 行精简入口
|
|
40
|
+
│ │ └── rules/ # 详细规则(按需加载)
|
|
41
|
+
│ ├── project-query/ # 重构后 115 行
|
|
42
|
+
│ ├── software-architecture/ # 重构后 116 行
|
|
43
|
+
│ └── ...
|
|
44
|
+
├── lib/ # 安装脚本
|
|
45
|
+
│ ├── install-cursor.sh # 已更新支持子目录
|
|
46
|
+
│ └── ...
|
|
47
|
+
├── config/ # 配置
|
|
48
|
+
└── README.md # 项目说明
|
|
96
49
|
```
|
|
97
50
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
详见 [docs/03-workflow.md](docs/03-workflow.md) — 含交互式流程图、三层泳道图、IDE 对比、用户旅程
|
|
51
|
+
## 架构设计
|
|
101
52
|
|
|
102
|
-
|
|
53
|
+
> 由 `project-analyze` skill 自动填充
|
|
103
54
|
|
|
104
|
-
##
|
|
55
|
+
## 🌟 特色功能
|
|
105
56
|
|
|
106
|
-
###
|
|
57
|
+
### 1. 智能技能系统
|
|
58
|
+
- **47+ 专业技能**: 涵盖 Java、Web、Python、Rust、Go 等主流技术栈
|
|
59
|
+
- **自动触发**: 根据项目类型自动应用相应规范
|
|
60
|
+
- **按需加载**: 仅加载相关技能内容,提升性能
|
|
107
61
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
| 项目查询 | 1 | project-query — 分析结果结构化查询系统 |
|
|
113
|
-
| 代码审查 | 1 | code-review — 8 维度评分 + CODE_REVIEW.md 报告 |
|
|
114
|
-
| 架构设计 | 1 | software-architecture — 风格选型 + 高并发 + DDD |
|
|
115
|
-
| 工作流 | 4 | brainstorming, clarify-before-build, smart-dispatch, writing-plans |
|
|
116
|
-
| 社区核心 | 6 | ai-project-architecture, doc-coauthoring, ui-ux-pro, webapp-testing ... |
|
|
117
|
-
| Office | 4 | pdf, docx, pptx, xlsx |
|
|
118
|
-
| Superpowers | ~15 | using-superpowers, TDD, debugging, verification ... |
|
|
62
|
+
### 2. 多 IDE 支持
|
|
63
|
+
- **Claude Code**: 原生支持,自动补全性能提升
|
|
64
|
+
- **Cursor**: 自动生成 .mdc 规则文件
|
|
65
|
+
- **Kiro**: 自动生成 steering 导航文件
|
|
119
66
|
|
|
120
|
-
|
|
67
|
+
### 3. 项目分析能力
|
|
68
|
+
- **深度分析**: 7 阶段管线,5 维度分析框架
|
|
69
|
+
- **知识图谱**: 14 节点 × 24 边依赖关系可视化
|
|
70
|
+
- **文档生成**: 自动生成 Zero-KT 标准项目文档
|
|
121
71
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
| Hook | 触发时机 | 作用 |
|
|
125
|
-
|------|----------|------|
|
|
126
|
-
| session-start | 每次新会话 | 注入 Skill 目录 + 项目栈 + 文档状态 + 澄清规则 |
|
|
127
|
-
| prompt-guard | 每条用户消息 | 实现类请求时注入澄清提醒(Tier 0-3 分级) |
|
|
128
|
-
| doc-sync-reminder | Write/Edit 后 | 源码变更后检查文档新鲜度,过期时提醒同步 |
|
|
129
|
-
|
|
130
|
-
详见 [docs/05-hooks.md](docs/05-hooks.md)
|
|
131
|
-
|
|
132
|
-
### MCP Servers(5 个)
|
|
133
|
-
|
|
134
|
-
context7(文档查询), filesystem(文件访问), git(版本控制), sequential-thinking(结构化推理), playwright(浏览器自动化)
|
|
135
|
-
|
|
136
|
-
详见 [docs/07-mcp-servers.md](docs/07-mcp-servers.md)
|
|
137
|
-
|
|
138
|
-
### 技术栈检测(17 种)
|
|
139
|
-
|
|
140
|
-
Java/Spring, React/Next.js, Vue/Nuxt, Svelte, Python, Go, Rust/Tauri, Android, iOS/Swift, Flutter, React Native, HarmonyOS, DevOps/K8s — 自动检测,零配置。
|
|
141
|
-
|
|
142
|
-
### 项目模板
|
|
143
|
-
|
|
144
|
-
根据技术栈自动生成 `CLAUDE.md` + `README.md` + `COMPONENT.md` + `UI_STYLE.md` + Cursor rules + Kiro steering,含真实项目数据(组件清单、路由表、依赖信息等)。
|
|
145
|
-
|
|
146
|
-
详见 [docs/06-templates.md](docs/06-templates.md)
|
|
147
|
-
|
|
148
|
-
---
|
|
149
|
-
|
|
150
|
-
## 文档目录
|
|
72
|
+
## 快速开始
|
|
151
73
|
|
|
152
|
-
|
|
153
|
-
|------|------|
|
|
154
|
-
| [docs/01-overview.md](docs/01-overview.md) | 项目概览 — 文档中心首页,含目录索引和阅读路径 |
|
|
155
|
-
| [docs/02-getting-started.md](docs/02-getting-started.md) | 快速开始 — 安装指南、环境检查、各 IDE 使用方式 |
|
|
156
|
-
| [docs/03-workflow.md](docs/03-workflow.md) | 工作流全景图 — 端到端流程、三层防线、IDE 对比、用户旅程 |
|
|
157
|
-
| [docs/04-skills.md](docs/04-skills.md) | Skills 系统 — 30 个 skill 详解、触发机制、开发规范 |
|
|
158
|
-
| [docs/05-hooks.md](docs/05-hooks.md) | Hooks 系统 — 3 个 hook 触发链、配置方式、跨 IDE 适配 |
|
|
159
|
-
| [docs/06-templates.md](docs/06-templates.md) | 模板系统 — 14 种技术栈检测、模板生成、变量替换 |
|
|
160
|
-
| [docs/07-mcp-servers.md](docs/07-mcp-servers.md) | MCP 服务器 — 5 个推荐服务器配置说明 |
|
|
161
|
-
| [docs/08-ide-support.md](docs/08-ide-support.md) | IDE 支持 — Claude Code / Cursor / Kiro 能力对比、适配策略 |
|
|
162
|
-
| [docs/09-architecture.md](docs/09-architecture.md) | 系统架构设计 — 模块结构、数据流、关键设计决策 |
|
|
163
|
-
| [docs/10-testing.md](docs/10-testing.md) | 测试指南 — 16 个测试套件、Fixture 说明、编写新测试 |
|
|
164
|
-
| [docs/11-advanced-features.md](docs/11-advanced-features.md) | 高级功能 — Agent 定义、jq 自动下载、环境变量、Monorepo |
|
|
165
|
-
| [docs/12-contributing.md](docs/12-contributing.md) | 贡献指南 — 开发规范、测试、添加新 skill/技术栈 |
|
|
74
|
+
### 1. 安装 aTool
|
|
166
75
|
|
|
167
|
-
|
|
76
|
+
```bash
|
|
77
|
+
# 克隆项目
|
|
78
|
+
git clone https://github.com/your-username/atool.git
|
|
79
|
+
cd atool
|
|
168
80
|
|
|
169
|
-
|
|
81
|
+
# 安装到 Claude Code
|
|
82
|
+
./install.sh --claude
|
|
170
83
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
| 安装脚本 | ✅ | ✅ | ✅ Git Bash / WSL |
|
|
174
|
-
| 全部功能 | ✅ | ✅ | ✅ |
|
|
175
|
-
| IDE 支持 | ✅ | ✅ | ✅ |
|
|
84
|
+
# 安装到 Cursor
|
|
85
|
+
./install.sh --cursor
|
|
176
86
|
|
|
177
|
-
|
|
87
|
+
# 安装到所有 IDE
|
|
88
|
+
./install.sh --all
|
|
89
|
+
```
|
|
178
90
|
|
|
179
|
-
|
|
91
|
+
### 2. 初始化项目
|
|
180
92
|
|
|
181
93
|
```bash
|
|
182
|
-
#
|
|
183
|
-
|
|
184
|
-
atool --all --yes # 重新安装
|
|
185
|
-
npm uninstall -g @dtt_siye/atool # 卸载 npm 包
|
|
186
|
-
atool --uninstall # 移除配置
|
|
187
|
-
|
|
188
|
-
# 源码方式
|
|
189
|
-
./install.sh --update # 一步式更新
|
|
190
|
-
./install.sh --check-updates # 检查更新
|
|
191
|
-
./install.sh --uninstall # 移除配置
|
|
192
|
-
```
|
|
94
|
+
# 在项目目录中运行
|
|
95
|
+
./install.sh --project .
|
|
193
96
|
|
|
194
|
-
|
|
97
|
+
# 或使用 aTool CLI
|
|
98
|
+
atool init
|
|
99
|
+
```
|
|
195
100
|
|
|
196
|
-
|
|
101
|
+
### 3. 使用技能
|
|
197
102
|
|
|
198
|
-
|
|
103
|
+
```bash
|
|
104
|
+
# 在 Claude Code 中使用自动补全
|
|
105
|
+
/java-conventions
|
|
106
|
+
/software-architecture
|
|
107
|
+
/project-analyze
|
|
199
108
|
|
|
109
|
+
# 查看所有技能
|
|
110
|
+
/skills
|
|
200
111
|
```
|
|
201
|
-
aTool/
|
|
202
|
-
├── install.sh # 主入口(CLI 参数解析 + 安装调度)
|
|
203
|
-
├── VERSION # 版本号
|
|
204
|
-
├── lib/ # 核心库(15 个模块)
|
|
205
|
-
│ ├── common.sh # 公共函数、日志、JSON 工具、模板替换、版本检测
|
|
206
|
-
│ ├── detect-stack.sh # 技术栈检测引擎(17 种)
|
|
207
|
-
│ ├── analyze-source.sh # 源码分析模块(18+ 扫描函数)
|
|
208
|
-
│ ├── project-init.sh # 项目初始化(monorepo + 单项目)
|
|
209
|
-
│ ├── install-{skills,hooks,mcp,claude,cursor,kiro}.sh
|
|
210
|
-
│ ├── compute-importance.sh # 模块重要性评分(8 因子加权)
|
|
211
|
-
│ ├── knowledge-graph.sh # 知识图谱工具(v5.0 共 11 个公开函数,CK 度量,介数中心性)
|
|
212
|
-
│ ├── multi-dimensional-analysis.sh # 五维分析框架(结构/行为/数据/质量/语义)
|
|
213
|
-
│ ├── generate-visualization.sh # Cytoscape.js 知识图谱可视化生成
|
|
214
|
-
│ └── visualization-template.html # 可视化 HTML 模板
|
|
215
|
-
├── skills/ # Skills 集合(31 个)
|
|
216
|
-
│ ├── _superpowers/ # Superpowers git submodule(v5.0.6)
|
|
217
|
-
│ ├── {11 conventions}/ # 技术栈编码规范
|
|
218
|
-
│ ├── project-analyze/ # 深度项目分析 v5.0(五维分析 + 知识图谱 + 可视化 + 8 因子评分)
|
|
219
|
-
│ ├── project-query/ # 分析结果结构化查询系统
|
|
220
|
-
│ ├── code-review/ # 代码质量审查 v0.3
|
|
221
|
-
│ ├── software-architecture/ # 架构设计 v1.0
|
|
222
|
-
│ ├── smart-dispatch/ # 并行计划执行
|
|
223
|
-
│ └── {community,office}/ # 社区 + Office skills
|
|
224
|
-
├── hooks/ # Hook 脚本(session-start, prompt-guard, doc-sync-reminder)
|
|
225
|
-
├── mcp/ # MCP 服务器配置
|
|
226
|
-
├── templates/ # 项目模板(79 个文件,13 栈 × 6 类型 + 1 monorepo)
|
|
227
|
-
├── agents/ # Agent 规则定义
|
|
228
|
-
├── tests/ # 测试(15 个套件 + 1 runner,850+ 用例)
|
|
229
|
-
└── docs/ # 项目文档
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
---
|
|
233
|
-
|
|
234
|
-
## 开发
|
|
235
112
|
|
|
236
|
-
|
|
237
|
-
# 运行全部测试
|
|
238
|
-
./tests/test-run-all.sh
|
|
113
|
+
## 开发规范
|
|
239
114
|
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
115
|
+
### 代码规范技能
|
|
116
|
+
- **java-conventions**: Java/Spring Boot 开发规范
|
|
117
|
+
- **web-conventions**: React/Vue/Web 开发规范
|
|
118
|
+
- **python-conventions**: Python/FastAPI 开发规范
|
|
119
|
+
- **rust-conventions**: Rust/Cargo 开发规范
|
|
244
120
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
121
|
+
### 架构设计技能
|
|
122
|
+
- **software-architecture**: 系统架构设计指导
|
|
123
|
+
- **ai-project-architecture**: AI 项目架构合规检查
|
|
124
|
+
- **project-analyze**: 深度项目分析
|
|
248
125
|
|
|
249
|
-
|
|
126
|
+
### 工作流技能
|
|
127
|
+
- **brainstorming**: 创意工作流程
|
|
128
|
+
- **writing-plans**: 计划制定
|
|
129
|
+
- **code-review**: 代码审查
|
|
130
|
+
- **systematic-debugging**: 系统性调试
|
|
250
131
|
|
|
251
|
-
|
|
132
|
+
## 模块说明
|
|
252
133
|
|
|
253
|
-
|
|
134
|
+
> 由 `project-analyze` skill 自动填充
|
|
254
135
|
|
|
255
|
-
|
|
136
|
+
| 模块 | 描述 |
|
|
137
|
+
|------|------|
|
|
138
|
+
| | |
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
# aTool - AI 开发者工具集
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@dtt_siye/atool)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](install.sh)
|
|
6
|
+
|
|
7
|
+
> 一键配置 AI IDE 的 Skills、MCP Servers、Hooks 和项目规则。让任何水平的开发者,通过在 IDE 中正常聊天,就能获得资深架构师的判断力、高级工程师的代码质量标准、和技术文档专家的交付质量。
|
|
8
|
+
|
|
9
|
+
**两种安装方式,30 秒完成配置:**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# 方式一:npm 安装(推荐,全局可用)
|
|
13
|
+
npx @dtt_siye/atool
|
|
14
|
+
|
|
15
|
+
# 方式二:从源码安装
|
|
16
|
+
git clone --recursive https://github.com/user/atool.git && cd atool
|
|
17
|
+
./install.sh --all --yes
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 支持的 IDE
|
|
23
|
+
|
|
24
|
+
| IDE | Skills | Hooks | 强制执行 | 特色 |
|
|
25
|
+
|-----|--------|-------|---------|------|
|
|
26
|
+
| **Claude Code** | ✅ SKILL.md | ✅ 全局(3 个) | **高** | Slash 命令 + 并行 Agent |
|
|
27
|
+
| **Cursor** | ✅ .mdc Rules | ⚠️ 项目级(3 个) | **中** | alwaysApply + globs 智能加载 |
|
|
28
|
+
| **Kiro** | ✅ Steering Markdown | ❌ | **低** | 合并精简 43→~8 文件(token -87%) |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 核心理念
|
|
33
|
+
|
|
34
|
+
1. **开箱即用** — 安装后在 IDE 中正常聊天,AI 自动加载工作流和编码规范
|
|
35
|
+
2. **项目自适应** — 自动检测 17 种技术栈,匹配对应编码规范(零配置)
|
|
36
|
+
3. **老旧代码分析** — 多 Agent 并行深度分析,5 分钟理解 30 分钟的代码
|
|
37
|
+
4. **文档自动同步** — 代码修改后自动提醒并更新文档,确保交付质量
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 快速开始
|
|
42
|
+
|
|
43
|
+
### npm 安装(推荐)
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# 一键安装到所有 IDE
|
|
47
|
+
npx @dtt_siye/atool
|
|
48
|
+
|
|
49
|
+
# 或全局安装后使用
|
|
50
|
+
npm install -g @dtt_siye/atool
|
|
51
|
+
|
|
52
|
+
# 基础安装
|
|
53
|
+
atool install # 安装到所有 IDE
|
|
54
|
+
atool install --claude # 仅安装到 Claude Code
|
|
55
|
+
|
|
56
|
+
# 项目初始化
|
|
57
|
+
atool init # 初始化当前目录项目
|
|
58
|
+
atool init ./my-app # 初始化指定目录项目
|
|
59
|
+
atool init --stack react # 指定技术栈初始化
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 从源码安装
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# 1. 安装到所有 IDE
|
|
66
|
+
./install.sh --all --yes
|
|
67
|
+
|
|
68
|
+
# 2. 初始化项目(自动检测技术栈 + 生成规则模板)
|
|
69
|
+
./install.sh --project /path/to/your/project
|
|
70
|
+
# 或
|
|
71
|
+
./install.sh --project --stack react /path/to/your/project
|
|
72
|
+
|
|
73
|
+
# 或在 Claude Code 中一步到位:
|
|
74
|
+
# /atool-init
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
> 详细安装指南参见 [docs/02-getting-started.md](docs/02-getting-started.md)
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## CLI 命令
|
|
82
|
+
|
|
83
|
+
### 安装命令
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
atool install # 安装到所有 IDE(默认)
|
|
87
|
+
atool install --claude # 仅安装到 Claude Code
|
|
88
|
+
atool install --cursor # 仅安装到 Cursor
|
|
89
|
+
atool install --kiro # 仅安装到 Kiro
|
|
90
|
+
atool install --all # 安装到所有 IDE(显式)
|
|
91
|
+
atool install --yes # 跳过确认提示
|
|
92
|
+
atool install --dry-run # 预览模式
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### 项目初始化
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
atool init # 初始化当前目录项目
|
|
99
|
+
atool init ./my-app # 初始化指定目录项目
|
|
100
|
+
atool init --stack react # 指定 React 技术栈
|
|
101
|
+
atool init --stack vue # 指定 Vue 技术栈
|
|
102
|
+
atool init --stack java # 指定 Java 技术栈
|
|
103
|
+
atool init --stack python # 指定 Python 技术栈
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 其他命令
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
atool update # 更新 aTool
|
|
110
|
+
atool check-updates # 检查更新(JSON 格式)
|
|
111
|
+
atool version # 显示版本
|
|
112
|
+
atool help # 显示帮助
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## CLI 选项
|
|
116
|
+
|
|
117
|
+
| 选项 | 描述 |
|
|
118
|
+
|------|------|
|
|
119
|
+
| `--all` | 安装到所有已检测到的 IDE |
|
|
120
|
+
| `--claude` / `--cursor` / `--kiro` | 仅安装到指定 IDE |
|
|
121
|
+
| `--project PATH` | 初始化项目(兼容旧版本,推荐使用 `atool init`) |
|
|
122
|
+
| `--analyze PATH` | 准备项目深度分析目录(配合 project-analyze skill) |
|
|
123
|
+
| `--stack STACK` | 指定技术栈(如 react、vue、java、python) |
|
|
124
|
+
| `--update` | 一步式更新(git pull + 自动重装变更组件) |
|
|
125
|
+
| `--uninstall` | 移除所有 aTool 配置 |
|
|
126
|
+
| `--dry-run` | 预览模式,不做任何实际修改 |
|
|
127
|
+
| `--force` | 强制覆盖(默认:合并 + 备份) |
|
|
128
|
+
| `--check-updates` | 检查更新(不安装) |
|
|
129
|
+
| `--yes` | 跳过确认提示 |
|
|
130
|
+
| `--version` / `--help` | 版本号 / 帮助信息 |
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 工作流全景
|
|
135
|
+
|
|
136
|
+
aTool 通过三层自动化防线串联所有功能,用户无需知道 skill 名称,正常聊天即可触发:
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
意图澄清(防幻觉) → 栈感知(自动规范) → 质量闭环(文档同步)
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
**用户说「帮我写个用户注册接口」→** AI 自动评估复杂度 → 问清需求 → 按 Spring 分层规范生成代码 → 自动更新文档 → 完成前验证
|
|
143
|
+
|
|
144
|
+
详见 [docs/03-workflow.md](docs/03-workflow.md) — 含交互式流程图、三层泳道图、IDE 对比、用户旅程
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## 功能一览
|
|
149
|
+
|
|
150
|
+
### Skills(31 个)
|
|
151
|
+
|
|
152
|
+
| 类型 | 数量 | 代表 Skills |
|
|
153
|
+
|------|:----:|------------|
|
|
154
|
+
| 技术栈规范 | 11 | java-conventions, web-conventions, python-conventions, go-conventions ... |
|
|
155
|
+
| 项目分析 | 1 | project-analyze — v5.0 五维分析框架,14 节点 × 24 边知识图谱,Cytoscape.js 可视化,8 因子评分,断点续传 |
|
|
156
|
+
| 项目查询 | 1 | project-query — 分析结果结构化查询系统 |
|
|
157
|
+
| 代码审查 | 1 | code-review — 8 维度评分 + CODE_REVIEW.md 报告 |
|
|
158
|
+
| 架构设计 | 1 | software-architecture — 风格选型 + 高并发 + DDD |
|
|
159
|
+
| 工作流 | 4 | brainstorming, clarify-before-build, smart-dispatch, writing-plans |
|
|
160
|
+
| 社区核心 | 6 | ai-project-architecture, doc-coauthoring, ui-ux-pro, webapp-testing ... |
|
|
161
|
+
| Office | 4 | pdf, docx, pptx, xlsx |
|
|
162
|
+
| Superpowers | ~15 | using-superpowers, TDD, debugging, verification ... |
|
|
163
|
+
|
|
164
|
+
详见 [docs/04-skills.md](docs/04-skills.md)
|
|
165
|
+
|
|
166
|
+
### Hooks(3 个自动拦截)
|
|
167
|
+
|
|
168
|
+
| Hook | 触发时机 | 作用 |
|
|
169
|
+
|------|----------|------|
|
|
170
|
+
| session-start | 每次新会话 | 注入 Skill 目录 + 项目栈 + 文档状态 + 澄清规则 |
|
|
171
|
+
| prompt-guard | 每条用户消息 | 实现类请求时注入澄清提醒(Tier 0-3 分级) |
|
|
172
|
+
| doc-sync-reminder | Write/Edit 后 | 源码变更后检查文档新鲜度,过期时提醒同步 |
|
|
173
|
+
|
|
174
|
+
详见 [docs/05-hooks.md](docs/05-hooks.md)
|
|
175
|
+
|
|
176
|
+
### MCP Servers(5 个)
|
|
177
|
+
|
|
178
|
+
context7(文档查询), filesystem(文件访问), git(版本控制), sequential-thinking(结构化推理), playwright(浏览器自动化)
|
|
179
|
+
|
|
180
|
+
详见 [docs/07-mcp-servers.md](docs/07-mcp-servers.md)
|
|
181
|
+
|
|
182
|
+
### 技术栈检测(17 种)
|
|
183
|
+
|
|
184
|
+
Java/Spring, React/Next.js, Vue/Nuxt, Svelte, Python, Go, Rust/Tauri, Android, iOS/Swift, Flutter, React Native, HarmonyOS, DevOps/K8s — 自动检测,零配置。
|
|
185
|
+
|
|
186
|
+
### 项目模板
|
|
187
|
+
|
|
188
|
+
根据技术栈自动生成 `CLAUDE.md` + `README.md` + `COMPONENT.md` + `UI_STYLE.md` + Cursor rules + Kiro steering,含真实项目数据(组件清单、路由表、依赖信息等)。
|
|
189
|
+
|
|
190
|
+
详见 [docs/06-templates.md](docs/06-templates.md)
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## 文档目录
|
|
195
|
+
|
|
196
|
+
| 文档 | 内容 |
|
|
197
|
+
|------|------|
|
|
198
|
+
| [docs/01-overview.md](docs/01-overview.md) | 项目概览 — 文档中心首页,含目录索引和阅读路径 |
|
|
199
|
+
| [docs/02-getting-started.md](docs/02-getting-started.md) | 快速开始 — 安装指南、环境检查、各 IDE 使用方式 |
|
|
200
|
+
| [docs/03-workflow.md](docs/03-workflow.md) | 工作流全景图 — 端到端流程、三层防线、IDE 对比、用户旅程 |
|
|
201
|
+
| [docs/04-skills.md](docs/04-skills.md) | Skills 系统 — 30 个 skill 详解、触发机制、开发规范 |
|
|
202
|
+
| [docs/05-hooks.md](docs/05-hooks.md) | Hooks 系统 — 3 个 hook 触发链、配置方式、跨 IDE 适配 |
|
|
203
|
+
| [docs/06-templates.md](docs/06-templates.md) | 模板系统 — 14 种技术栈检测、模板生成、变量替换 |
|
|
204
|
+
| [docs/07-mcp-servers.md](docs/07-mcp-servers.md) | MCP 服务器 — 5 个推荐服务器配置说明 |
|
|
205
|
+
| [docs/08-ide-support.md](docs/08-ide-support.md) | IDE 支持 — Claude Code / Cursor / Kiro 能力对比、适配策略 |
|
|
206
|
+
| [docs/09-architecture.md](docs/09-architecture.md) | 系统架构设计 — 模块结构、数据流、关键设计决策 |
|
|
207
|
+
| [docs/10-testing.md](docs/10-testing.md) | 测试指南 — 16 个测试套件、Fixture 说明、编写新测试 |
|
|
208
|
+
| [docs/11-advanced-features.md](docs/11-advanced-features.md) | 高级功能 — Agent 定义、jq 自动下载、环境变量、Monorepo |
|
|
209
|
+
| [docs/12-contributing.md](docs/12-contributing.md) | 贡献指南 — 开发规范、测试、添加新 skill/技术栈 |
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## 平台支持
|
|
214
|
+
|
|
215
|
+
| | macOS | Linux | Windows |
|
|
216
|
+
|---|:-----:|:-----:|:-------:|
|
|
217
|
+
| 安装脚本 | ✅ | ✅ | ✅ Git Bash / WSL |
|
|
218
|
+
| 全部功能 | ✅ | ✅ | ✅ |
|
|
219
|
+
| IDE 支持 | ✅ | ✅ | ✅ |
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## 更新与卸载
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
# npm 方式
|
|
227
|
+
npm update -g @dtt_siye/atool # 更新
|
|
228
|
+
atool --all --yes # 重新安装
|
|
229
|
+
npm uninstall -g @dtt_siye/atool # 卸载 npm 包
|
|
230
|
+
atool --uninstall # 移除配置
|
|
231
|
+
|
|
232
|
+
# 源码方式
|
|
233
|
+
./install.sh --update # 一步式更新
|
|
234
|
+
./install.sh --check-updates # 检查更新
|
|
235
|
+
./install.sh --uninstall # 移除配置
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
更新策略:Skills 按内容 checksum 增量更新,Cursor/Kiro staging 按 checksum 比较,MCP 使用 JSON 深度合并,Hooks 按 MD5 校验。详见 [docs/09-architecture.md](docs/09-architecture.md)。
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## 项目结构
|
|
243
|
+
|
|
244
|
+
```
|
|
245
|
+
aTool/
|
|
246
|
+
├── install.sh # 主入口(CLI 参数解析 + 安装调度)
|
|
247
|
+
├── VERSION # 版本号
|
|
248
|
+
├── lib/ # 核心库(15 个模块)
|
|
249
|
+
│ ├── common.sh # 公共函数、日志、JSON 工具、模板替换、版本检测
|
|
250
|
+
│ ├── detect-stack.sh # 技术栈检测引擎(17 种)
|
|
251
|
+
│ ├── analyze-source.sh # 源码分析模块(18+ 扫描函数)
|
|
252
|
+
│ ├── project-init.sh # 项目初始化(monorepo + 单项目)
|
|
253
|
+
│ ├── install-{skills,hooks,mcp,claude,cursor,kiro}.sh
|
|
254
|
+
│ ├── compute-importance.sh # 模块重要性评分(8 因子加权)
|
|
255
|
+
│ ├── knowledge-graph.sh # 知识图谱工具(v5.0 共 11 个公开函数,CK 度量,介数中心性)
|
|
256
|
+
│ ├── multi-dimensional-analysis.sh # 五维分析框架(结构/行为/数据/质量/语义)
|
|
257
|
+
│ ├── generate-visualization.sh # Cytoscape.js 知识图谱可视化生成
|
|
258
|
+
│ └── visualization-template.html # 可视化 HTML 模板
|
|
259
|
+
├── skills/ # Skills 集合(31 个)
|
|
260
|
+
│ ├── _superpowers/ # Superpowers git submodule(v5.0.6)
|
|
261
|
+
│ ├── {11 conventions}/ # 技术栈编码规范
|
|
262
|
+
│ ├── project-analyze/ # 深度项目分析 v5.0(五维分析 + 知识图谱 + 可视化 + 8 因子评分)
|
|
263
|
+
│ ├── project-query/ # 分析结果结构化查询系统
|
|
264
|
+
│ ├── code-review/ # 代码质量审查 v0.3
|
|
265
|
+
│ ├── software-architecture/ # 架构设计 v1.0
|
|
266
|
+
│ ├── smart-dispatch/ # 并行计划执行
|
|
267
|
+
│ └── {community,office}/ # 社区 + Office skills
|
|
268
|
+
├── hooks/ # Hook 脚本(session-start, prompt-guard, doc-sync-reminder)
|
|
269
|
+
├── mcp/ # MCP 服务器配置
|
|
270
|
+
├── templates/ # 项目模板(79 个文件,13 栈 × 6 类型 + 1 monorepo)
|
|
271
|
+
├── agents/ # Agent 规则定义
|
|
272
|
+
├── tests/ # 测试(15 个套件 + 1 runner,850+ 用例)
|
|
273
|
+
└── docs/ # 项目文档
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
---
|
|
277
|
+
|
|
278
|
+
## 开发
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
# 运行全部测试
|
|
282
|
+
./tests/test-run-all.sh
|
|
283
|
+
|
|
284
|
+
# 单个测试
|
|
285
|
+
./tests/test-detect-stack.sh # 技术栈检测(47 用例)
|
|
286
|
+
./tests/test-skill-conversion.sh # Skill 格式转换(45 用例)
|
|
287
|
+
./tests/test-core-workflows.sh # 核心链路集成(61 用例)
|
|
288
|
+
|
|
289
|
+
# Dry-run 预览
|
|
290
|
+
./install.sh --dry-run --all
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
欢迎贡献!详见 [docs/12-contributing.md](docs/12-contributing.md)。
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
## 许可证
|
|
298
|
+
|
|
299
|
+
[MIT License](LICENSE) - Copyright (c) 2025 aTool Contributors
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.5.0
|