huhaa-myskills 0.2.13 → 0.3.4

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.
Files changed (121) hide show
  1. package/README.md +9 -375
  2. package/bin/huhaa-myskills.mjs +194 -12
  3. package/{scripts → build}/verify.mjs +3 -1
  4. package/docs/Frontend-Spec.md +1149 -0
  5. package/docs/assets/layout-wireframe.png +0 -0
  6. package/docs/assets/theme-reference.png +0 -0
  7. package/docs/scan_rules.md +172 -0
  8. package/package.json +33 -9
  9. package/packages/scanner/src/adapters/directory-skill.mjs +239 -0
  10. package/packages/scanner/src/adapters/skill-adapter.mjs +345 -0
  11. package/packages/scanner/src/icon/brand-map.mjs +84 -0
  12. package/packages/scanner/src/icon/icon-extractor.mjs +246 -0
  13. package/packages/scanner/src/index.mjs +107 -82
  14. package/packages/scanner/src/types.d.ts +18 -0
  15. package/packages/scanner/test/icon.test.mjs +61 -0
  16. package/packages/scanner/test/scanner.test.mjs +37 -41
  17. package/packages/scanner/test/skill-adapter.test.mjs +70 -0
  18. package/packages/scanner/tests/directory-skill.test.mjs +93 -0
  19. package/packages/scanner/tests/scanner-integration.test.mjs +139 -0
  20. package/packages/server/src/index.mjs +164 -12
  21. package/packages/server/src/labels.mjs +62 -0
  22. package/packages/server/test/server.test.mjs +1 -1
  23. package/packages/web/README.md +33 -2
  24. package/packages/web/dist/assets/index-BCY2cRaO.js +175 -0
  25. package/packages/web/dist/assets/index-DALKjJPi.css +1 -0
  26. package/packages/web/dist/favicon-16x16.png +0 -0
  27. package/packages/web/dist/favicon-192x192.png +0 -0
  28. package/packages/web/dist/favicon-32x32.png +0 -0
  29. package/packages/web/dist/favicon-512x512.png +0 -0
  30. package/packages/web/dist/favicon-source.svg +5 -0
  31. package/packages/web/dist/index.html +23 -9
  32. package/packages/web/index.html +22 -8
  33. package/packages/web/package-lock.json +2989 -0
  34. package/packages/web/package.json +21 -8
  35. package/packages/web/postcss.config.js +6 -0
  36. package/packages/web/public/favicon-16x16.png +0 -0
  37. package/packages/web/public/favicon-192x192.png +0 -0
  38. package/packages/web/public/favicon-32x32.png +0 -0
  39. package/packages/web/public/favicon-512x512.png +0 -0
  40. package/packages/web/public/favicon-source.svg +5 -0
  41. package/packages/web/src/App.test.ts +40 -0
  42. package/packages/web/src/App.tsx +177 -0
  43. package/packages/web/src/components/ComingSoon.tsx +14 -0
  44. package/packages/web/src/components/layout/Sidebar.test.tsx +74 -0
  45. package/packages/web/src/components/layout/Sidebar.tsx +114 -0
  46. package/packages/web/src/components/layout/Topbar.tsx +74 -0
  47. package/packages/web/src/components/ui/ActionButton.tsx +48 -0
  48. package/packages/web/src/components/ui/button.tsx +48 -0
  49. package/packages/web/src/components/ui/card.tsx +45 -0
  50. package/packages/web/src/components/views/DashboardView.tsx +122 -0
  51. package/packages/web/src/components/views/OtherSkillsView.test.tsx +126 -0
  52. package/packages/web/src/components/views/OtherSkillsView.tsx +306 -0
  53. package/packages/web/src/components/views/SettingsView.tsx +95 -0
  54. package/packages/web/src/components/views/SkillDetail.test.tsx +57 -0
  55. package/packages/web/src/components/views/SkillDetail.tsx +81 -0
  56. package/packages/web/src/components/views/SkillsView.test.ts +28 -0
  57. package/packages/web/src/components/views/SkillsView.tsx +226 -0
  58. package/packages/web/src/hooks/QUICK_REFERENCE.md +165 -0
  59. package/packages/web/src/hooks/README.md +378 -0
  60. package/packages/web/src/hooks/__tests__/useOtherSkills.test.ts +422 -0
  61. package/packages/web/src/hooks/__tests__/useSkillIcons.test.ts +272 -0
  62. package/packages/web/src/hooks/useLiveReload.ts +20 -0
  63. package/packages/web/src/hooks/useOtherSkills.ts +387 -0
  64. package/packages/web/src/hooks/useSkillIcons.ts +248 -0
  65. package/packages/web/src/hooks/useTheme.ts +36 -0
  66. package/packages/web/src/index.css +161 -0
  67. package/packages/web/src/lib/api.test.ts +47 -0
  68. package/packages/web/src/lib/api.ts +77 -0
  69. package/packages/web/src/lib/cn.ts +7 -0
  70. package/packages/web/src/lib/editors.test.ts +30 -0
  71. package/packages/web/src/lib/editors.ts +70 -0
  72. package/packages/web/src/lib/markdown.test.ts +27 -0
  73. package/packages/web/src/lib/markdown.ts +14 -0
  74. package/packages/web/src/main.tsx +13 -0
  75. package/packages/web/src/types/index.ts +62 -0
  76. package/packages/web/src/types/other-skill.ts +88 -0
  77. package/packages/web/src/types/skill.ts +136 -0
  78. package/packages/web/src/types.ts +47 -0
  79. package/packages/web/src/vite-env.d.ts +1 -0
  80. package/packages/web/tailwind.config.ts +66 -0
  81. package/packages/web/tsconfig.json +28 -0
  82. package/packages/web/vite.config.ts +36 -0
  83. package/packages/web/vitest.config.ts +21 -0
  84. package/packages/web/vitest.setup.ts +1 -0
  85. package/scripts/activate-data-sources.sh +223 -0
  86. package/scripts/brand-completion.py +586 -0
  87. package/scripts/init-nextjs-project.sh +421 -0
  88. package/scripts/install-and-sync.sh +209 -0
  89. package/scripts/start-dev.sh +72 -0
  90. package/docs/GUIDE.md +0 -190
  91. package/docs/PLAN.md +0 -359
  92. package/docs/RULES.md +0 -329
  93. package/docs/RUNBOOK-myskills.md +0 -258
  94. package/docs/SYNC-SKILLS.md +0 -259
  95. package/docs/releases/README.md +0 -47
  96. package/docs/releases/v0.1.0.md +0 -256
  97. package/docs/releases/v0.1.1.md +0 -297
  98. package/docs/releases/v0.1.2.md +0 -207
  99. package/docs/releases/v0.1.3.md +0 -269
  100. package/docs/todo/v0.1.2.md +0 -98
  101. package/docs/todo/v0.1.3.md +0 -40
  102. package/docs/todo/v0.1.4.md +0 -36
  103. package/docs/todo/v0.1.5.md +0 -41
  104. package/docs/todo/v0.1.6.md +0 -43
  105. package/docs/todo/v0.1.7.md +0 -38
  106. package/docs/todo/v0.1.8.md +0 -36
  107. package/docs/todo/v0.1.9.md +0 -54
  108. package/packages/web/dist/assets/index-BPepSb3q.js +0 -36
  109. package/packages/web/dist/assets/index-CIGkgT5w.css +0 -1
  110. package/packages/web/src/App.vue +0 -483
  111. package/packages/web/src/components/AppTree.vue +0 -230
  112. package/packages/web/src/components/DirectoryTree.vue +0 -263
  113. package/packages/web/src/components/SkillTree.vue +0 -208
  114. package/packages/web/src/lib/api.js +0 -43
  115. package/packages/web/src/main.js +0 -6
  116. package/packages/web/src/stores/i18n.js +0 -161
  117. package/packages/web/src/stores/skills.js +0 -287
  118. package/packages/web/src/styles.css +0 -365
  119. package/packages/web/vite.config.js +0 -17
  120. /package/{scripts → build}/build-web.mjs +0 -0
  121. /package/{scripts → build}/prepare-publish.mjs +0 -0
@@ -1,259 +0,0 @@
1
- # HuHaa-MySkills 编辑器技能同步 (v0.1.2)
2
-
3
- 本文档说明如何使用编辑器技能自动同步功能。
4
-
5
- ## 快速开始
6
-
7
- ### 方式 1:本地安装后同步
8
-
9
- ```bash
10
- # 克隆项目
11
- git clone https://github.com/aquarkgn/HuHaa-MySkills.git
12
- cd HuHaa-MySkills
13
-
14
- # 执行同步脚本(交互模式)
15
- npm run sync
16
- # 或直接运行
17
- bash service/scripts/sync-skills.sh
18
- ```
19
-
20
- ### 方式 2:远程一键安装 + 同步
21
-
22
- ```bash
23
- # 通过 curl 直接执行(推荐)
24
- curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash
25
- ```
26
-
27
- ### 方式 3:仅同步(已安装项目后)
28
-
29
- ```bash
30
- npm run sync
31
- # 或
32
- npm run sync:remote
33
- ```
34
-
35
- ---
36
-
37
- ## 功能说明
38
-
39
- ### 自动编辑器检测
40
-
41
- 脚本会自动扫描以下编辑器,并列出已安装的编辑器:
42
-
43
- | 编辑器 | macOS 配置位置 | Linux 配置位置 |
44
- |------------|----------------------------------------------------|-----------------------------|
45
- | **Cursor** | `~/Library/Application Support/Cursor` | `~/.config/Cursor` |
46
- | **VS Code** | `~/Library/Application Support/Code` | `~/.config/Code` |
47
- | **Helix** | `~/Library/Application Support/helix` | `~/.config/helix` |
48
- | **Neovim** | `~/.config/nvim` | `~/.config/nvim` |
49
- | **Sublime** | `~/Library/Application Support/Sublime Text` | `~/.config/sublime-text-3` |
50
- | **Windsurf** | `~/Library/Application Support/Windsurf` | `~/.config/Windsurf` |
51
-
52
- ### 交互式选择
53
-
54
- ```
55
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
56
- 请选择要同步技能的编辑器(多选)
57
- ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
58
-
59
- [1] cursor
60
- Path: /Users/mac/Library/Application Support/Cursor
61
-
62
- [2] vscode
63
- Path: /Users/mac/Library/Application Support/Code
64
-
65
- [3] helix
66
- Path: /Users/mac/Library/Application Support/helix
67
-
68
- 0 - 全选
69
- q - 退出
70
-
71
- 请输入选择 (使用逗号分隔多个): 1,2
72
- ```
73
-
74
- **支持的输入方式:**
75
- - `1` - 选择第一个编辑器
76
- - `1,2,3` - 选择多个编辑器
77
- - `0` - 全选所有编辑器
78
- - `q` - 取消操作
79
-
80
- ### 同步功能
81
-
82
- 脚本会将项目的技能和配置同步到选中的编辑器:
83
-
84
- #### Cursor
85
- - 同步 `.cursorrules` 文件到编辑器配置目录
86
- - 自动备份原有的 `.cursorrules`
87
-
88
- #### VS Code
89
- - 复制代码片段和脚本到编辑器的 snippets 目录
90
- - 支持自定义代码补全
91
-
92
- #### Helix
93
- - 同步 `config.toml` 配置文件
94
- - 集成 HuHaa 自定义命令
95
-
96
- #### Neovim
97
- - 生成 `init.lua` 基础配置
98
- - 加载 HuHaa 自定义配置
99
-
100
- #### Sublime Text
101
- - 同步用户设置和代码片段
102
-
103
- #### Windsurf
104
- - 同步编辑器配置
105
-
106
- ---
107
-
108
- ## 使用示例
109
-
110
- ### 示例 1:在本地项目中同步所有编辑器
111
-
112
- ```bash
113
- cd /path/to/HuHaa-MySkills
114
- npm run sync
115
-
116
- # 选择: 0(全选)
117
- ```
118
-
119
- ### 示例 2:只同步 Cursor
120
-
121
- ```bash
122
- npm run sync
123
-
124
- # 选择: 1(假设 Cursor 是第一个)
125
- ```
126
-
127
- ### 示例 3:从远程直接运行(新机器)
128
-
129
- ```bash
130
- # 自动安装 + 同步一体化
131
- curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash
132
-
133
- # 或者只执行同步
134
- curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash -s -- --sync-only
135
- ```
136
-
137
- ### 示例 4:本地项目路径
138
-
139
- ```bash
140
- # 如果脚本在其他位置,指定本地项目路径
141
- bash /path/to/sync-skills.sh --local /path/to/HuHaa-MySkills
142
- ```
143
-
144
- ---
145
-
146
- ## 环境变量
147
-
148
- 脚本支持以下环境变量来自定义行为:
149
-
150
- ```bash
151
- # 指定本地项目路径
152
- export HUHAA_LOCAL_PATH="/path/to/HuHaa-MySkills"
153
-
154
- # 指定远程仓库 URL(默认:https://github.com/aquarkgn/HuHaa-MySkills.git)
155
- export HUHAA_REPO_URL="https://github.com/your-fork/HuHaa-MySkills.git"
156
-
157
- # 指定原始内容 URL(默认:https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills)
158
- export HUHAA_REPO_RAW="https://raw.githubusercontent.com/your-fork/HuHaa-MySkills"
159
-
160
- # 执行脚本
161
- bash service/scripts/sync-skills.sh
162
- ```
163
-
164
- ---
165
-
166
- ## 常见问题
167
-
168
- ### Q: 脚本找不到我的编辑器配置?
169
-
170
- **A:** 某些编辑器在非标准位置安装。你可以:
171
- 1. 检查编辑器是否在支持列表中
172
- 2. 确认编辑器配置目录是否存在
173
- 3. 手动指定项目路径:`HUHAA_LOCAL_PATH=/path/to/project bash service/scripts/sync-skills.sh`
174
-
175
- ### Q: 同步会覆盖我的现有配置吗?
176
-
177
- **A:** 脚本会:
178
- - 为 Cursor 的 `.cursorrules` 创建备份(`.cursorrules.backup`)
179
- - 对于其他编辑器,如果配置文件已存在,会跳过覆盖并显示警告
180
- - 不会无故删除任何文件
181
-
182
- ### Q: 可以部分同步吗?
183
-
184
- **A:** 可以!选择需要同步的编辑器即可:
185
- ```bash
186
- npm run sync
187
- # 选择: 1,3(只同步第 1 和第 3 个编辑器)
188
- ```
189
-
190
- ### Q: 如何撤销同步?
191
-
192
- **A:** 如果有备份,恢复备份文件:
193
- ```bash
194
- # 恢复 Cursor 备份
195
- cp ~/.cursor/.cursorrules.backup ~/.cursor/.cursorrules
196
- ```
197
-
198
- ### Q: 脚本支持 Windows 吗?
199
-
200
- **A:** 支持 Windows WSL(Windows Subsystem for Linux)。在 PowerShell 中:
201
- ```powershell
202
- wsl bash -c "curl -fsSL https://raw.githubusercontent.com/aquarkgn/HuHaa-MySkills/main/install-and-sync.sh | bash"
203
- ```
204
-
205
- ---
206
-
207
- ## 故障排查
208
-
209
- ### 脚本执行权限错误
210
-
211
- ```bash
212
- # 添加执行权限
213
- chmod +x service/scripts/sync-skills.sh
214
- bash service/scripts/sync-skills.sh
215
- ```
216
-
217
- ### 网络连接问题
218
-
219
- 如果 curl 下载失败,可尝试:
220
- 1. 检查网络连接
221
- 2. 使用代理:`curl -x [proxy-url] ...`
222
- 3. 使用本地项目:`npm run sync`
223
-
224
- ### 编辑器不被识别
225
-
226
- 检查编辑器配置目录是否存在:
227
- ```bash
228
- # macOS
229
- ls ~/Library/Application\ Support/Cursor
230
- ls ~/Library/Application\ Support/Code
231
- ls ~/.config/nvim # Linux
232
-
233
- # Linux
234
- ls ~/.config/Cursor
235
- ls ~/.config/Code
236
- ls ~/.config/helix
237
- ```
238
-
239
- ---
240
-
241
- ## 后续更新
242
-
243
- 脚本会在新版本中增加:
244
- - [ ] 更多编辑器支持(Emacs, Vim, etc)
245
- - [ ] 配置文件版本管理
246
- - [ ] 回滚功能
247
- - [ ] 增量同步(只同步改变的部分)
248
-
249
- ---
250
-
251
- ## 相关文档
252
-
253
- - [快速启动指南](./GUIDE.md)
254
- - [项目规划](./PLAN.md)
255
- - [发布规范](./RULES.md)
256
-
257
- ---
258
-
259
- **v0.1.2 首发功能** | [GitHub](https://github.com/aquarkgn/HuHaa-MySkills)
@@ -1,47 +0,0 @@
1
- # 版本发布历史
2
-
3
- 本目录包含每个版本的详细发布说明。
4
-
5
- ## 🚀 已发布版本
6
-
7
- | 版本 | 日期 | 主题 | 文档 |
8
- |------|------|------|------|
9
- | **v0.1.1** | 2026-06-18 | npm 全局安装支持 | [详情](./v0.1.1.md) |
10
- | **v0.1.0** | 2026-06-17 | 首个可用版本 | [详情](./v0.1.0.md) |
11
-
12
- ## 📋 计划中的版本
13
-
14
- | 版本 | 预期日期 | 主题 | 计划文档 |
15
- |------|---------|------|---------|
16
- | **v0.1.2** | 2026-06-30 | Hermes 技能集成 + 搜索优化 | [v0.1.2 计划](../todo/v0.1.2.md) / [发布说明](./v0.1.2.md) |
17
- | **v0.1.3** | 2026-07-07 | Obsidian + Claude.md 支持 | [v0.1.3 计划](../todo/v0.1.3.md) |
18
- | **v0.1.4** | 2026-07-21 | 分组与筛选增强 | [v0.1.4 计划](../todo/v0.1.4.md) |
19
- | **v0.1.5** | 2026-07-28 | 导出与分享 | [v0.1.5 计划](../todo/v0.1.5.md) |
20
- | **v0.1.6** | 2026-08-11 | 增量扫描与缓存 | [v0.1.6 计划](../todo/v0.1.6.md) |
21
- | **v0.1.7** | 2026-08-25 | 跨平台完整支持 | [v0.1.7 计划](../todo/v0.1.7.md) |
22
- | **v0.1.8** | 2026-09-01 | 开发者工具 | [v0.1.8 计划](../todo/v0.1.8.md) |
23
- | **v0.1.9** | 2026-09-15 | 完成度冲刺 | [v0.1.9 计划](../todo/v0.1.9.md) |
24
-
25
- ## 📖 如何阅读版本说明
26
-
27
- 每个发布版本的详细说明包含:
28
-
29
- - **🎯 版本目标** - 这个版本要达成什么
30
- - **✨ 新增功能** - 具体增加了哪些功能
31
- - **🐛 Bug 修复** - 修复了哪些问题
32
- - **📊 性能对比** - 性能改进数据
33
- - **🧪 测试覆盖** - 测试情况
34
- - **📦 发行物** - 如何获取这个版本
35
- - **🚀 安装指南** - 如何安装和升级
36
- - **📝 Breaking Changes** - 是否有不兼容改动
37
- - **🔄 迁移指南** - 如何从旧版本升级
38
-
39
- ## 🔗 相关资源
40
-
41
- - [CHANGELOG.md](../../CHANGELOG.md) - 简明版本历史
42
- - [版本计划](../todo/) - 未来版本计划
43
- - [发布规范](../RULES.md) - 如何发布版本
44
-
45
- ---
46
-
47
- **最后更新**: 2026-06-18
@@ -1,256 +0,0 @@
1
- # v0.1.0 - 本地技能聚合中心首个可用版本
2
-
3
- **发布日期**: 2026-06-17
4
- **发布状态**: ✅ 正式发布
5
- **GitHub**: [Release v0.1.0](https://github.com/aquarkgn/HuHaa-MySkills/releases/tag/v0.1.0)
6
-
7
- ---
8
-
9
- ## 🎯 版本目标
10
-
11
- 完成 P0-P7 完整实现(8 小时净工作量),交付一个可用的本地技能聚合浏览器,实现多源技能的统一查找和复制。
12
-
13
- ## 📋 版本主题
14
-
15
- **本地技能聚合中心** - 将散落在 Hermes / Claude Code / Cursor / MCP 等多个工具中的技能统一汇聚到一个本地浏览器,提供搜索、筛选、复制等快速操作。
16
-
17
- ---
18
-
19
- ## ✨ 新增功能
20
-
21
- ### 核心功能
22
- - 🎯 **多源聚合** - 聚合 Hermes、Claude Code、Cursor Rules、MCP Config、Project Runbook 等 5+ 个源
23
- - 🔍 **全文搜索** - 基于 Fuse.js 的前端全文搜索,延迟 < 5ms
24
- - 📂 **智能分组** - 支持按源、分类、品牌、产品四种维度分组浏览
25
- - 📋 **详情页** - 查看技能的完整信息、参数、使用说明、相关链接
26
- - 📋 **一键复制** - 复制路径、复制原文、复制 frontmatter
27
- - 🔗 **编辑器跳转** - 点击"在 Cursor 中打开"直接打开文件
28
- - 🔄 **热更新** - 修改技能文件后 < 1s 自动刷新页面(chokidar watch)
29
-
30
- ### 技术架构
31
- - **前端**: Vite 5 + Vue 3 + TypeScript + Pinia + Vuetify
32
- - **后端**: Fastify 5 + Node.js 20+
33
- - **扫描**: 多源适配器 + 统一 IR 数据结构
34
- - **通信**: SSE (Server-Sent Events) 实时推送
35
-
36
- ### 支持的源
37
-
38
- | 源 | 路径 | 类型 | 说明 |
39
- |---|------|------|------|
40
- | Hermes | `~/.hermes/skills/*/SKILL.md` | skill | Hermes 官方技能库 |
41
- | Claude Code | `~/.claude/skills/*/SKILL.md` | skill | Claude Code 技能 |
42
- | MCP Config | `~/.cursor/mcp.json` 等 | mcp | MCP 服务器定义 |
43
- | Cursor Rules | `.cursorrules` / `.cursor/rules/` | agent-rule | Cursor 规则 |
44
- | Project Runbook | `docs/RUNBOOK-*.md` | runbook | 项目文档 |
45
-
46
- ---
47
-
48
- ## 🐛 已知限制
49
-
50
- ### 功能限制
51
- - ❌ 不支持在网页端编辑技能(只读浏览)
52
- - ❌ 不支持跨机器同步(本地工具)
53
- - ❌ 不支持直接执行技能(复制后由编辑器执行)
54
- - ❌ Windows / Linux 尽量兼容但不是一等公民
55
-
56
- ### 平台兼容性
57
- - ✅ macOS - 完全支持
58
- - ⚠️ Linux - 功能完整,部分工具集成需要调整
59
- - ⚠️ Windows - 功能完整,路径和剪贴板需要调整
60
-
61
- ---
62
-
63
- ## 📊 性能指标
64
-
65
- | 指标 | 目标 | 实现 |
66
- |------|------|------|
67
- | 首启动 | < 2s | ~1s(扫描 800 文件) |
68
- | 热更新 | < 500ms | ~300ms |
69
- | 搜索延迟 | < 10ms | ~5ms(800 条目) |
70
- | 内存占用 | < 100MB | ~50MB |
71
- | 列表滚动 | 60fps | ✅ 完整虚拟滚动 |
72
-
73
- ---
74
-
75
- ## 🧪 测试覆盖
76
-
77
- - ✅ 单元测试 - 6 个核心测试用例
78
- - ✅ 集成测试 - Fastify API 完整覆盖
79
- - ✅ E2E 验证 - `npm run verify` smoke test
80
- - ✅ 安全检查 - 路径穿越防护、XSS 防护
81
-
82
- **覆盖率**: 适配器与 server 90% 行覆盖
83
-
84
- ---
85
-
86
- ## 📚 文档
87
-
88
- - ✅ `README.md` - 项目概览和安装指南
89
- - ✅ `docs/PLAN.md` - 详细架构设计文档
90
- - ✅ `docs/RUNBOOK-myskills.md` - 使用说明
91
- - ⚠️ 快速启动指南 - 计划在 v0.1.2 完善
92
-
93
- ---
94
-
95
- ## 🚀 安装使用
96
-
97
- ### 快速开始
98
- ```bash
99
- git clone https://github.com/aquarkgn/HuHaa-MySkills.git
100
- cd HuHaa-MySkills
101
- npm install
102
- npm start
103
- # 浏览器自动打开 http://localhost:11520
104
- ```
105
-
106
- ### 常用命令
107
- ```bash
108
- npm start # 启动并打开浏览器
109
- npm run scan # 仅扫描,输出 IR JSON
110
- npm run stats # 统计信息
111
- npm run dev # 开发模式
112
- npm test # 运行测试
113
- npm run verify # 完整性检查
114
- ```
115
-
116
- ---
117
-
118
- ## 📈 本地扫描统计
119
-
120
- 用户本机数据统计(实际测试):
121
- - Hermes skills: 660+ 条
122
- - Claude Code skills: ~50 条
123
- - MCP configs: ~15 个
124
- - Project Runbooks: ~20 条
125
- - Cursor Rules: ~10 条
126
-
127
- **总计**: 750+ 条目,本地 SPA 完全可用
128
-
129
- ---
130
-
131
- ## 🎨 使用场景
132
-
133
- ### 场景 1:快速查找 Hermes 技能
134
- 1. 浏览器打开 localhost:11520
135
- 2. 搜索框输入关键词
136
- 3. 找到目标技能
137
- 4. 点击"复制原文"
138
- 5. 粘贴到 Cursor 上下文
139
-
140
- ### 场景 2:浏览所有 MCP 服务
141
- 1. 分组切换为"source"
142
- 2. 选择"mcp-config"
143
- 3. 查看所有 MCP 服务定义
144
- 4. 复制工具定义到 Cursor
145
-
146
- ### 场景 3:快速查看项目 Runbook
147
- 1. 分组切换为"kind"
148
- 2. 选择"runbook"
149
- 3. 查看所有项目文档
150
- 4. 点击"在 Cursor 中打开"
151
-
152
- ---
153
-
154
- ## 🔧 配置文件
155
-
156
- ### sources.yaml
157
-
158
- 首次启动自动生成在用户数据目录:
159
- ```yaml
160
- sources:
161
- hermes:
162
- enabled: true
163
- roots:
164
- - ~/.hermes/skills
165
-
166
- claude-code:
167
- enabled: true
168
- roots:
169
- - ~/.claude/skills
170
-
171
- mcp-config:
172
- enabled: true
173
- files:
174
- - ~/.cursor/mcp.json
175
-
176
- limits:
177
- maxFiles: 5000
178
- maxFileBytes: 1048576
179
- ```
180
-
181
- ---
182
-
183
- ## 🔐 安全设计
184
-
185
- - ✅ Localhost only - 绑定 127.0.0.1,不支持远程访问
186
- - ✅ 路径白名单 - `/api/open` 和 `/api/copy` 都有白名单验证
187
- - ✅ 无上传下载 - 纯只读浏览,不写入用户文件
188
- - ✅ 无网络通信 - 完全本地工作,无任何远程请求
189
-
190
- ---
191
-
192
- ## 📦 技术栈
193
-
194
- ### 后端
195
- - Fastify 5 - HTTP 框架
196
- - Node.js 20+ - 运行时
197
- - Chokidar - 文件监听
198
- - YAML / TOML - 配置解析
199
-
200
- ### 前端
201
- - Vite 5 - 构建工具
202
- - Vue 3 - UI 框架
203
- - TypeScript - 类型安全
204
- - Pinia - 状态管理
205
- - Fuse.js - 搜索引擎
206
- - Vuetify - 组件库
207
-
208
- ---
209
-
210
- ## 🏗️ 项目结构
211
-
212
- ```
213
- HuHaa-MySkills/
214
- ├── service/
215
- │ ├── bin/ # CLI 入口
216
- │ ├── packages/
217
- │ │ ├── scanner/ # 扫描器 + 适配器
218
- │ │ ├── server/ # HTTP 服务器
219
- │ │ └── web/ # Vue 前端
220
- │ ├── config/ # 配置文件示例
221
- │ └── scripts/ # 工具脚本
222
- ├── docs/ # 文档
223
- ├── package.json # 工作空间配置
224
- └── README.md
225
- ```
226
-
227
- ---
228
-
229
- ## 🔜 下一步(v0.1.1+)
230
-
231
- - [ ] npm 全局安装支持
232
- - [ ] 更多数据源支持
233
- - [ ] 性能优化
234
- - [ ] 跨平台完整支持
235
- - [ ] 开发者工具
236
-
237
- 详见 [版本计划](../todo/)
238
-
239
- ---
240
-
241
- ## 🙏 贡献者
242
-
243
- - **Nolan** - 核心开发
244
-
245
- ---
246
-
247
- ## 📄 许可证
248
-
249
- MIT - 详见 [LICENSE](../../LICENSE)
250
-
251
- ---
252
-
253
- **相关链接**:
254
- - [GitHub 项目](https://github.com/aquarkgn/HuHaa-MySkills)
255
- - [完整架构](../PLAN.md)
256
- - [操作手册](../RUNBOOK-myskills.md)