huhaa-myskills 0.1.5
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/LICENSE +21 -0
- package/README.md +384 -0
- package/docs/GUIDE.md +190 -0
- package/docs/PLAN.md +359 -0
- package/docs/RULES.md +329 -0
- package/docs/RUNBOOK-myskills.md +258 -0
- package/docs/SYNC-SKILLS.md +259 -0
- package/docs/releases/README.md +47 -0
- package/docs/releases/v0.1.0.md +256 -0
- package/docs/releases/v0.1.1.md +297 -0
- package/docs/releases/v0.1.2.md +207 -0
- package/docs/releases/v0.1.3.md +269 -0
- package/docs/todo/v0.1.2.md +98 -0
- package/docs/todo/v0.1.3.md +40 -0
- package/docs/todo/v0.1.4.md +36 -0
- package/docs/todo/v0.1.5.md +41 -0
- package/docs/todo/v0.1.6.md +43 -0
- package/docs/todo/v0.1.7.md +38 -0
- package/docs/todo/v0.1.8.md +36 -0
- package/docs/todo/v0.1.9.md +54 -0
- package/install-and-sync.sh +209 -0
- package/package.json +68 -0
- package/service/bin/huhaa-myskills.mjs +314 -0
- package/service/bin/lib/paths.mjs +57 -0
- package/service/bin/lib/port.mjs +23 -0
- package/service/config/sources.example.yaml +121 -0
- package/service/packages/scanner/src/adapters/file-docs.mjs +158 -0
- package/service/packages/scanner/src/adapters/hermes-plugin.mjs +149 -0
- package/service/packages/scanner/src/adapters/markdown-skill.mjs +219 -0
- package/service/packages/scanner/src/adapters/mcp-config.mjs +171 -0
- package/service/packages/scanner/src/index.mjs +234 -0
- package/service/packages/scanner/src/types.d.ts +88 -0
- package/service/packages/scanner/src/utils.mjs +186 -0
- package/service/packages/server/src/index.mjs +549 -0
- package/service/packages/web/README.md +5 -0
- package/service/packages/web/dist/assets/index-CTh5OdBd.js +36 -0
- package/service/packages/web/dist/assets/index-CtoiGnQ7.css +1 -0
- package/service/packages/web/dist/index.html +13 -0
- package/service/scripts/build-web.mjs +29 -0
- package/service/scripts/prepare-publish.mjs +44 -0
- package/service/scripts/restore-publish.mjs +17 -0
- package/service/scripts/sync-skills.sh +427 -0
- package/service/scripts/verify.mjs +132 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 HuHaa
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,384 @@
|
|
|
1
|
+
# 🎯 HuHaa-MySkills
|
|
2
|
+
|
|
3
|
+
**本地 AI 技能聚合中枢** — 一行命令发现、同步、管理你所有的 AI 技能和编辑器规则
|
|
4
|
+
|
|
5
|
+
> 把散落在 Hermes / Claude Code / Cursor / Codex / Obsidian / 各项目里的「技能、插件、MCP、规则」全部聚合到一个浏览器界面。搜索、复制、在编辑器中打开,一切就在本地。
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🚀 一键启动(推荐)
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**做了什么?**
|
|
16
|
+
1. 检查系统要求(Node.js 20+)
|
|
17
|
+
2. npm 全局安装 HuHaa-MySkills
|
|
18
|
+
3. 自动扫描已安装的编辑器(全球 20+ 款编辑器和开发工具)
|
|
19
|
+
4. 显示交互菜单,让你选择要同步的编辑器
|
|
20
|
+
5. 自动同步技能配置
|
|
21
|
+
6. 启动本地服务 `http://localhost:11520`
|
|
22
|
+
|
|
23
|
+
**支持的编辑器和工具:**
|
|
24
|
+
- **代码编辑器** — Cursor、VS Code、VS Code Insiders、Windsurf、Zed、Sublime Text、TextMate
|
|
25
|
+
- **终端编辑器** — Neovim、Vim、Emacs、Helix
|
|
26
|
+
- **其他编辑器** — Atom、Kate、Gedit、BBEdit、JetBrains IDEs
|
|
27
|
+
- **新兴工具** — Openclaw、Herems、Trae、Trae CN
|
|
28
|
+
|
|
29
|
+
**就这么简单!** 无需 git clone,无需手动配置,一条命令搞定。
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## ✨ 核心功能
|
|
34
|
+
|
|
35
|
+
### 🔍 多源技能聚合
|
|
36
|
+
|
|
37
|
+
HuHaa-MySkills 自动扫描并统一展示:
|
|
38
|
+
|
|
39
|
+
- **Hermes Skills** - `~/.hermes/skills/*/SKILL.md`
|
|
40
|
+
- **Claude Code Skills** - `~/.claude/skills/*/SKILL.md`
|
|
41
|
+
- **Cursor Rules** - `~/.cursor/.cursorrules` 和 `.cursor/rules/*`
|
|
42
|
+
- **Codex Instructions** - `AGENTS.md` 和 `CLAUDE.md`
|
|
43
|
+
- **MCP Servers** - 自动识别所有配置的 MCP 服务和工具
|
|
44
|
+
- **Hermes Plugins** - `~/.hermes/plugins/*/manifest.*`
|
|
45
|
+
- **项目 Runbooks** - 项目根目录的 `docs/RUNBOOK-*.md`
|
|
46
|
+
- **Obsidian Notes** - 带 `#skill` 标签的笔记(可选)
|
|
47
|
+
|
|
48
|
+
### 💻 浏览器界面(localhost:11520)
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
┌─────────────────────────────────────────────────────┐
|
|
52
|
+
│ HuHaa-MySkills - 技能中心 │
|
|
53
|
+
├─────────────────────────────────────────────────────┤
|
|
54
|
+
│ │
|
|
55
|
+
│ 左侧树状目录 右侧预览/详情 │
|
|
56
|
+
│ ├─ 按来源分组 ┌──────────────────┐ │
|
|
57
|
+
│ ├─ 按类别分组 │ skill: new-api │ │
|
|
58
|
+
│ ├─ 按品牌分组 │ 部署优化技能 │ │
|
|
59
|
+
│ └─ 按产品分组 │ │ │
|
|
60
|
+
│ │ 📋 复制路径 │ │
|
|
61
|
+
│ 🔍 搜索框 │ 📝 复制原文 │ │
|
|
62
|
+
│ (支持快捷键 /) │ 🔧 在 Cursor打开 │ │
|
|
63
|
+
│ └──────────────────┘ │
|
|
64
|
+
└─────────────────────────────────────────────────────┘
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 🎯 功能特性
|
|
68
|
+
|
|
69
|
+
- **快速搜索** - Fuse.js 全文搜索,<5ms 延迟,支持 800+ 条目
|
|
70
|
+
- **多维度过滤** - 按来源、编辑器、品牌、类别、产品组合筛选
|
|
71
|
+
- **一键复制** - 复制路径、相对路径、原文本、调用 prompt
|
|
72
|
+
- **编辑器集成** - 在 Cursor / VS Code 中一键打开
|
|
73
|
+
- **热更新** - 文件变更自动刷新界面
|
|
74
|
+
- **智能同步** - 自动同步技能到 20+ 个编辑器配置(v0.1.3+)
|
|
75
|
+
- **本地优先** - 零上传,所有数据在本地,无云依赖
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 📖 使用流程
|
|
80
|
+
|
|
81
|
+
### 1️⃣ 安装 & 初始化(一键完成)
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
🎉 第一次运行会:
|
|
88
|
+
- 安装依赖
|
|
89
|
+
- 初始化配置 `~/.config/huhaa-myskills/sources.yaml`
|
|
90
|
+
- 自动启动浏览器打开 `http://localhost:11520`
|
|
91
|
+
|
|
92
|
+
### 2️⃣ 浏览器中探索
|
|
93
|
+
|
|
94
|
+
访问 **http://localhost:11520**:
|
|
95
|
+
- 搜索你的技能(例:输入 "deploy" 找部署相关技能)
|
|
96
|
+
- 点击任何技能查看详情
|
|
97
|
+
- 复制到剪贴板或在编辑器中打开
|
|
98
|
+
|
|
99
|
+
### 3️⃣ 同步到编辑器(可选)
|
|
100
|
+
|
|
101
|
+
如果要让技能配置与编辑器同步:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
# 已全局安装的情况下
|
|
105
|
+
huhaa-myskills sync
|
|
106
|
+
|
|
107
|
+
# 或用 npm
|
|
108
|
+
npm run sync
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
交互选择要同步的编辑器,自动完成。
|
|
112
|
+
|
|
113
|
+
### 4️⃣ 后续启动
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
# 启动浏览器界面
|
|
117
|
+
huhaa-myskills start
|
|
118
|
+
|
|
119
|
+
# 查看统计信息
|
|
120
|
+
huhaa-myskills stats
|
|
121
|
+
|
|
122
|
+
# 扫描并输出 JSON(调试用)
|
|
123
|
+
huhaa-myskills scan
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## 🔧 配置
|
|
129
|
+
|
|
130
|
+
### 默认配置位置
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
~/.config/huhaa-myskills/sources.yaml
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### 添加更多扫描源
|
|
137
|
+
|
|
138
|
+
编辑 `sources.yaml`,例如添加项目 runbooks:
|
|
139
|
+
|
|
140
|
+
```yaml
|
|
141
|
+
sources:
|
|
142
|
+
hermes:
|
|
143
|
+
enabled: true
|
|
144
|
+
claude-code:
|
|
145
|
+
enabled: true
|
|
146
|
+
mcp-config:
|
|
147
|
+
enabled: true
|
|
148
|
+
|
|
149
|
+
# 添加项目目录
|
|
150
|
+
project-runbook:
|
|
151
|
+
enabled: true
|
|
152
|
+
roots:
|
|
153
|
+
- ~/Project/HuHaa-AI-Platform
|
|
154
|
+
- ~/Project/Another-Project
|
|
155
|
+
glob: 'docs/RUNBOOK-*.md'
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
保存后浏览器会自动重新扫描。
|
|
159
|
+
|
|
160
|
+
### 自定义数据目录
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
HUHAA_HOME=/tmp/huhaa-myskills huhaa-myskills start
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### 自定义端口
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
PORT=11530 huhaa-myskills start
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## 📋 其他安装方式
|
|
175
|
+
|
|
176
|
+
### 方式 B:本地克隆(适合开发者)
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
git clone https://github.com/aquarkgn/HuHaa-MySkills.git
|
|
180
|
+
cd HuHaa-MySkills
|
|
181
|
+
npm install
|
|
182
|
+
npm start
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### 方式 C:npm 全局安装(不含编辑器同步)
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
npm install -g github:aquarkgn/HuHaa-MySkills
|
|
189
|
+
huhaa-myskills init
|
|
190
|
+
huhaa-myskills start
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
---
|
|
194
|
+
|
|
195
|
+
## 🎮 v0.1.2 新增:编辑器技能同步
|
|
196
|
+
|
|
197
|
+
自动将项目技能同步到你的所有编辑器配置目录。
|
|
198
|
+
|
|
199
|
+
**支持的编辑器:**
|
|
200
|
+
- Cursor - 同步 `.cursorrules`
|
|
201
|
+
- VS Code - 同步代码片段
|
|
202
|
+
- Helix - 同步 `config.toml`
|
|
203
|
+
- Neovim - 生成 `init.lua`
|
|
204
|
+
- Sublime Text - 同步用户设置
|
|
205
|
+
- Windsurf - 同步编辑器配置
|
|
206
|
+
|
|
207
|
+
**使用:**
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
# 方式 1:交互选择
|
|
211
|
+
npm run sync
|
|
212
|
+
|
|
213
|
+
# 方式 2:远程执行
|
|
214
|
+
npm run sync:remote
|
|
215
|
+
|
|
216
|
+
# 选择要同步的编辑器
|
|
217
|
+
# [1] cursor
|
|
218
|
+
# [2] vscode
|
|
219
|
+
# ...
|
|
220
|
+
# 请输入选择: 0 # 全选
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## 🔐 安全性
|
|
226
|
+
|
|
227
|
+
HuHaa-MySkills 是本地优先的设计:
|
|
228
|
+
|
|
229
|
+
- ✅ **零上传** - 所有数据在本地 `~/.config/huhaa-myskills/`
|
|
230
|
+
- ✅ **仅本地绑定** - 服务器只监听 `127.0.0.1`,不暴露到网络
|
|
231
|
+
- ✅ **路径白名单** - 复制/打开文件严格校验,防止路径穿越
|
|
232
|
+
- ✅ **配置隐蔽** - MCP 密钥等敏感信息在浏览器中被屏蔽
|
|
233
|
+
- ✅ **无云依赖** - 完全离线工作,无 telemetry
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## 📊 了解更多
|
|
238
|
+
|
|
239
|
+
| 文档 | 链接 |
|
|
240
|
+
|------|------|
|
|
241
|
+
| 完整使用指南 | [docs/SYNC-SKILLS.md](./docs/SYNC-SKILLS.md) |
|
|
242
|
+
| 快速启动 | [docs/GUIDE.md](./docs/GUIDE.md) |
|
|
243
|
+
| 发布规范 | [docs/RULES.md](./docs/RULES.md) |
|
|
244
|
+
| 项目规划 | [docs/PLAN.md](./docs/PLAN.md) |
|
|
245
|
+
| API 文档 | 见下方 API 部分 |
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## 🛠 命令参考(高级)
|
|
250
|
+
|
|
251
|
+
首次安装后自动配置完成。以下命令用于日常管理和调试:
|
|
252
|
+
|
|
253
|
+
| 命令 | 说明 |
|
|
254
|
+
|------|------|
|
|
255
|
+
| `huhaa-myskills start` | 启动服务,自动打开浏览器 |
|
|
256
|
+
| `huhaa-myskills init` | 重新初始化配置 |
|
|
257
|
+
| `huhaa-myskills scan` | 扫描并输出 JSON 到命令行 |
|
|
258
|
+
| `huhaa-myskills stats` | 显示扫描统计 |
|
|
259
|
+
| `huhaa-myskills duplicates` | 查找重复项目 |
|
|
260
|
+
| `huhaa-myskills sync` | 同步技能到编辑器(交互式) |
|
|
261
|
+
| `huhaa-myskills purge` | 删除所有数据和配置 |
|
|
262
|
+
|
|
263
|
+
对应 npm scripts:
|
|
264
|
+
```bash
|
|
265
|
+
npm start # 启动
|
|
266
|
+
npm run init # 初始化
|
|
267
|
+
npm run scan # 扫描
|
|
268
|
+
npm run stats # 统计
|
|
269
|
+
npm run sync # 编辑器同步
|
|
270
|
+
npm run purge # 删除数据
|
|
271
|
+
npm run dev # 开发模式(热重载)
|
|
272
|
+
npm test # 运行测试
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
---
|
|
276
|
+
|
|
277
|
+
## 🧪 验证安装
|
|
278
|
+
|
|
279
|
+
确保系统完整性:
|
|
280
|
+
|
|
281
|
+
```bash
|
|
282
|
+
npm run verify
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
预期输出:
|
|
286
|
+
```
|
|
287
|
+
[verify] PASS build + tests + HTTP/API/static smoke checks
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
---
|
|
291
|
+
|
|
292
|
+
## 🚮 卸载 & 清理
|
|
293
|
+
|
|
294
|
+
完全移除 HuHaa-MySkills 和相关数据:
|
|
295
|
+
|
|
296
|
+
```bash
|
|
297
|
+
# 删除所有配置和数据
|
|
298
|
+
npm run purge
|
|
299
|
+
|
|
300
|
+
# 删除全局安装(如已全局安装)
|
|
301
|
+
npm uninstall -g huhaa-myskills
|
|
302
|
+
|
|
303
|
+
# 删除项目代码
|
|
304
|
+
rm -rf HuHaa-MySkills
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
---
|
|
308
|
+
|
|
309
|
+
## 💻 系统要求
|
|
310
|
+
|
|
311
|
+
- **Node.js** 20+(自动检查)
|
|
312
|
+
- **npm** 8+
|
|
313
|
+
- **macOS** 或 **Linux**(Windows 需要 WSL 或类似环境)
|
|
314
|
+
|
|
315
|
+
macOS 额外支持:
|
|
316
|
+
- `pbcopy` 用于剪贴板操作
|
|
317
|
+
- Finder "显示文件" 功能
|
|
318
|
+
- Cursor 编辑器集成
|
|
319
|
+
|
|
320
|
+
---
|
|
321
|
+
|
|
322
|
+
## 🏗 项目结构(开发者)
|
|
323
|
+
|
|
324
|
+
```
|
|
325
|
+
service/bin/ CLI 入口
|
|
326
|
+
service/packages/
|
|
327
|
+
├─ scanner/ 多源适配器 + IR 规范化
|
|
328
|
+
├─ server/ Fastify API 服务
|
|
329
|
+
└─ web/ Vue 3 前端 SPA
|
|
330
|
+
service/scripts/ 工具脚本(同步、验证等)
|
|
331
|
+
service/config/ 配置模板
|
|
332
|
+
docs/ 文档和规划
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
---
|
|
336
|
+
|
|
337
|
+
## 🔗 API 参考(前端开发)
|
|
338
|
+
|
|
339
|
+
| 方法 | 端点 | 说明 |
|
|
340
|
+
|------|------|------|
|
|
341
|
+
| GET | `/api/health` | 健康检查 |
|
|
342
|
+
| GET | `/api/skills` | 获取所有技能列表 |
|
|
343
|
+
| GET | `/api/skills/:id` | 获取单个技能详情(含 raw) |
|
|
344
|
+
| GET | `/api/stats` | 获取扫描统计 |
|
|
345
|
+
| GET | `/api/reload-state` | 获取重载状态 |
|
|
346
|
+
| POST | `/api/reload` | 触发重新扫描 |
|
|
347
|
+
| GET | `/api/events` | SSE 事件流 |
|
|
348
|
+
| POST | `/api/copy` | 复制到剪贴板 |
|
|
349
|
+
| POST | `/api/open` | 在编辑器中打开 |
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
## 📈 版本历史
|
|
354
|
+
|
|
355
|
+
- **v0.1.4** (2026-06-18) - 多源扫描增强(~/skills、~/mcp、~/skill)
|
|
356
|
+
- **v0.1.3** (2026-06-18) - 全球 20+ 编辑器支持
|
|
357
|
+
- **v0.1.2** (2026-06-18) - 编辑器技能自动同步
|
|
358
|
+
- **v0.1.1** (2026-06-18) - npm 全局安装支持
|
|
359
|
+
- **v0.1.0** (2026-06-17) - 首个可用版本
|
|
360
|
+
|
|
361
|
+
[查看完整版本历史](./CHANGELOG.md)
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
## 📝 贡献指南
|
|
366
|
+
|
|
367
|
+
感谢你的贡献!请参考 [RULES.md](./docs/RULES.md) 了解:
|
|
368
|
+
- Conventional Commits 规范
|
|
369
|
+
- Pull Request 流程
|
|
370
|
+
- Issue 报告格式
|
|
371
|
+
|
|
372
|
+
---
|
|
373
|
+
|
|
374
|
+
## 📄 许可证
|
|
375
|
+
|
|
376
|
+
MIT
|
|
377
|
+
|
|
378
|
+
---
|
|
379
|
+
|
|
380
|
+
**问题反馈** → [GitHub Issues](https://github.com/aquarkgn/HuHaa-MySkills/issues)
|
|
381
|
+
|
|
382
|
+
**功能建议** → [Discussion](https://github.com/aquarkgn/HuHaa-MySkills/discussions)
|
|
383
|
+
|
|
384
|
+
**快速开始** → 回到上面的 [🚀 一键启动](#-一键启动推荐)
|
package/docs/GUIDE.md
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
# HuHaa-MySkills 快速启动指南
|
|
2
|
+
|
|
3
|
+
> 5 分钟内将 HuHaa-MySkills 部署到你的本地环境
|
|
4
|
+
|
|
5
|
+
## 前置条件
|
|
6
|
+
|
|
7
|
+
- **Node.js 20+** - 检查:`node --version`
|
|
8
|
+
- **npm** - 检查:`npm --version`
|
|
9
|
+
- **macOS/Linux/Windows** - 支持所有平台
|
|
10
|
+
|
|
11
|
+
## 安装方式
|
|
12
|
+
|
|
13
|
+
### 选项 A:快速启动(推荐)
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# 1. 克隆到 Project 目录
|
|
17
|
+
cd ~/Project
|
|
18
|
+
git clone https://github.com/aquarkgn/HuHaa-MySkills.git
|
|
19
|
+
cd HuHaa-MySkills
|
|
20
|
+
|
|
21
|
+
# 2. 安装依赖
|
|
22
|
+
npm install
|
|
23
|
+
|
|
24
|
+
# 3. 启动(自动打开浏览器)
|
|
25
|
+
npm start
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
✓ 完成。浏览器会自动打开 `http://localhost:11520`
|
|
29
|
+
|
|
30
|
+
### 选项 B:全局 CLI
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# 一次安装,到处使用
|
|
34
|
+
npm install -g github:aquarkgn/HuHaa-MySkills
|
|
35
|
+
|
|
36
|
+
# 任何目录启动
|
|
37
|
+
huhaa-myskills start
|
|
38
|
+
huhaa-myskills scan
|
|
39
|
+
huhaa-myskills stats
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### 选项 C:从 Hermes 技能启动
|
|
43
|
+
|
|
44
|
+
在 Hermes 或 Claude Code 中调用技能 `huhaa-myskills-manager`:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
"启动 huhaa" 或 "打开技能中心"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
自动判断状态并启动。
|
|
51
|
+
|
|
52
|
+
## 首次配置
|
|
53
|
+
|
|
54
|
+
### 1. 自动生成配置文件
|
|
55
|
+
|
|
56
|
+
首次启动时,HuHaa 会在用户数据目录创建 `sources.yaml`:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
# macOS / Linux
|
|
60
|
+
~/.config/huhaa-myskills/sources.yaml
|
|
61
|
+
|
|
62
|
+
# 或指定自定义路径
|
|
63
|
+
export HUHAA_HOME=/path/to/config
|
|
64
|
+
npm start
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 2. 默认扫描源
|
|
68
|
+
|
|
69
|
+
| 源 | 路径 | 说明 |
|
|
70
|
+
|----|------|------|
|
|
71
|
+
| **hermes** | `~/.hermes/skills/` | Hermes 技能库 |
|
|
72
|
+
| **claude-code** | `~/.claude/skills/` | Claude Code 技能 |
|
|
73
|
+
| **mcp-config** | 各配置文件 | MCP 服务器定义 |
|
|
74
|
+
| **cursor-rules** | `.cursorrules` 等 | Cursor 规则 |
|
|
75
|
+
| **project-runbook** | `docs/RUNBOOK-*.md` | 项目文档 |
|
|
76
|
+
|
|
77
|
+
### 3. 自定义扫描源
|
|
78
|
+
|
|
79
|
+
编辑 `sources.yaml` 添加新源:
|
|
80
|
+
|
|
81
|
+
```yaml
|
|
82
|
+
sources:
|
|
83
|
+
hermes:
|
|
84
|
+
enabled: true
|
|
85
|
+
roots:
|
|
86
|
+
- ~/.hermes/skills
|
|
87
|
+
|
|
88
|
+
my-project-skills:
|
|
89
|
+
enabled: true
|
|
90
|
+
roots:
|
|
91
|
+
- ~/Project/MyProject/skills
|
|
92
|
+
glob: "**/*.md"
|
|
93
|
+
|
|
94
|
+
limits:
|
|
95
|
+
maxFiles: 5000
|
|
96
|
+
maxFileBytes: 1048576
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## 核心命令
|
|
100
|
+
|
|
101
|
+
| 命令 | 说明 |
|
|
102
|
+
|------|------|
|
|
103
|
+
| `npm start` | 启动并打开浏览器 |
|
|
104
|
+
| `npm run scan` | 仅扫描,输出 JSON |
|
|
105
|
+
| `npm run stats` | 统计信息 |
|
|
106
|
+
| `npm run dev` | 开发模式(热重载) |
|
|
107
|
+
| `npm run verify` | 完整性检查 |
|
|
108
|
+
| `npm test` | 运行测试 |
|
|
109
|
+
|
|
110
|
+
## 使用场景
|
|
111
|
+
|
|
112
|
+
### 场景 1:查找技能
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
# 浏览器打开 localhost:11520
|
|
116
|
+
# ↓
|
|
117
|
+
# 搜索框输入关键词(支持中文)
|
|
118
|
+
# ↓
|
|
119
|
+
# 找到目标技能
|
|
120
|
+
# ↓
|
|
121
|
+
# 点击"复制原文" 或 "复制路径"
|
|
122
|
+
# ↓
|
|
123
|
+
# 粘贴到 Cursor 上下文使用
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 场景 2:浏览所有 MCP
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
# 主页左侧分组切换为 "source"
|
|
130
|
+
# ↓
|
|
131
|
+
# 选择 "mcp-config"
|
|
132
|
+
# ↓
|
|
133
|
+
# 查看所有已配置的 MCP 服务器和工具
|
|
134
|
+
# ↓
|
|
135
|
+
# 在详情页复制工具定义
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### 场景 3:开发新技能
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
# 1. 在编辑器中创建 ~/.hermes/skills/my-skill/SKILL.md
|
|
142
|
+
# 2. HuHaa 会在 1 秒内自动检测并显示
|
|
143
|
+
# 3. 实时查看、测试、调试
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## 故障排查
|
|
147
|
+
|
|
148
|
+
### 端口被占用
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
PORT=11521 npm start
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### 依赖安装失败
|
|
155
|
+
|
|
156
|
+
```bash
|
|
157
|
+
rm -rf node_modules package-lock.json
|
|
158
|
+
npm install
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### 某个源为 unavailable
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
# 检查源配置
|
|
165
|
+
cat ~/.config/huhaa-myskills/sources.yaml
|
|
166
|
+
|
|
167
|
+
# 或诊断
|
|
168
|
+
huhaa-myskills doctor # v0.1.8+ 支持
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### 搜索性能慢
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
# 编辑 sources.yaml,添加 exclude 规则
|
|
175
|
+
exclude:
|
|
176
|
+
- "**/node_modules"
|
|
177
|
+
- "**/.git"
|
|
178
|
+
- "**/dist"
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
## 下一步
|
|
182
|
+
|
|
183
|
+
- 📖 [完整文档](../README.md)
|
|
184
|
+
- 🏗️ [架构设计](./PLAN.md)
|
|
185
|
+
- 📋 [版本计划](./todo/)
|
|
186
|
+
- 🚀 [Runbook](./RUNBOOK-myskills.md)
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
**需要帮助?** → [GitHub Issues](https://github.com/aquarkgn/HuHaa-MySkills/issues)
|