@workskills/getskill 1.2.0 → 2.1.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/EXAMPLES.md +98 -72
- package/README.md +167 -200
- package/dist/lib/config.d.ts +81 -4
- package/dist/lib/config.js +473 -21
- package/dist/lib/skill-manager.d.ts +7 -4
- package/dist/lib/skill-manager.js +55 -118
- package/dist/lib/state.d.ts +11 -0
- package/dist/lib/state.js +126 -14
- package/dist/lib/system.d.ts +0 -6
- package/dist/lib/system.js +0 -159
- package/dist/lib/types.d.ts +14 -28
- package/dist/main.d.ts +9 -5
- package/dist/main.js +280 -89
- package/package.json +9 -4
- package/dist/lib/skill-validator.d.ts +0 -4
- package/dist/lib/skill-validator.js +0 -107
package/EXAMPLES.md
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
# GetSkill 使用示例
|
|
2
2
|
|
|
3
|
-
> 当前版本基于 `getskill.work` 静态索引 + ZIP
|
|
3
|
+
> 当前版本基于 `getskill.work` 静态索引 + ZIP 包下载,提供**搜索、下载(安装)、更新**三大核心功能,全部**无需 Git、无需登录**。
|
|
4
4
|
|
|
5
5
|
## 场景 1: 搜索并安装技能
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
# 搜索技能
|
|
9
|
-
$ getskill search pdf
|
|
9
|
+
$ getskill search pdf-toolkit
|
|
10
10
|
|
|
11
11
|
找到 1 个技能:
|
|
12
12
|
|
|
13
|
-
1. pdf-
|
|
14
|
-
描述:
|
|
13
|
+
1. pdf-toolkit (v1.0.0)
|
|
14
|
+
描述: PDF 文档处理技能:提取文本、合并拆分、页面旋转与加水印。
|
|
15
15
|
分类: 文档处理
|
|
16
|
-
下载: https://getskill.work/skills/pdf-
|
|
16
|
+
下载: https://getskill.work/skills/pdf-toolkit.zip
|
|
17
17
|
|
|
18
18
|
# 安装技能
|
|
19
|
-
$ getskill install pdf-
|
|
19
|
+
$ getskill install pdf-toolkit
|
|
20
20
|
|
|
21
|
-
下载技能: pdf-
|
|
22
|
-
下载技能包: https://getskill.work/skills/pdf-
|
|
23
|
-
下载完成 (
|
|
24
|
-
|
|
25
|
-
技能 pdf-extract (v1.0.0) 安装成功!
|
|
21
|
+
下载技能: pdf-toolkit...
|
|
22
|
+
下载技能包: https://getskill.work/skills/pdf-toolkit.zip
|
|
23
|
+
下载完成 (1025 bytes),正在解压...
|
|
24
|
+
技能 pdf-toolkit (v1.0.0) 安装成功!
|
|
26
25
|
|
|
26
|
+
目标 Agent: claude (Claude Code)
|
|
27
27
|
技能已安装到 skills 目录:
|
|
28
|
-
- ~/.
|
|
28
|
+
- ~/.claude/skills/pdf-toolkit
|
|
29
29
|
|
|
30
|
-
本地缓存: ~/.
|
|
30
|
+
本地缓存: ~/.getskill/cache/pdf-toolkit/pdf-toolkit
|
|
31
31
|
已安装版本: 1.0.0
|
|
32
32
|
```
|
|
33
33
|
|
|
@@ -37,46 +37,54 @@ $ getskill install pdf-extract
|
|
|
37
37
|
# 列出已安装的技能
|
|
38
38
|
$ getskill list
|
|
39
39
|
|
|
40
|
-
本地已安装的技能 (1):
|
|
41
|
-
1. pdf-
|
|
40
|
+
本地已安装的技能 (1) · Agent: claude · 目录: ~/.claude/skills
|
|
41
|
+
1. pdf-toolkit
|
|
42
42
|
|
|
43
43
|
# 检查更新(版本比较)
|
|
44
|
-
$ getskill update pdf-
|
|
44
|
+
$ getskill update pdf-toolkit
|
|
45
45
|
|
|
46
|
-
正在更新技能: pdf-
|
|
46
|
+
正在更新技能: pdf-toolkit...
|
|
47
47
|
发现新版本: 1.0.0 -> 1.1.0
|
|
48
|
-
下载技能包: https://getskill.work/skills/pdf-
|
|
48
|
+
下载技能包: https://getskill.work/skills/pdf-toolkit.zip
|
|
49
49
|
下载完成 (175000 bytes),正在解压...
|
|
50
|
-
技能 pdf-
|
|
50
|
+
技能 pdf-toolkit 更新成功!
|
|
51
51
|
|
|
52
|
+
目标 Agent: claude (Claude Code)
|
|
52
53
|
技能已更新到 skills 目录:
|
|
53
|
-
- ~/.
|
|
54
|
+
- ~/.claude/skills/pdf-toolkit
|
|
54
55
|
当前版本: 1.1.0
|
|
55
56
|
|
|
56
57
|
# 已是最新时
|
|
57
|
-
$ getskill update pdf-
|
|
58
|
+
$ getskill update pdf-toolkit
|
|
58
59
|
|
|
59
|
-
正在更新技能: pdf-
|
|
60
|
-
技能 pdf-
|
|
60
|
+
正在更新技能: pdf-toolkit...
|
|
61
|
+
技能 pdf-toolkit 已是最新版本 (1.1.0),无需更新
|
|
61
62
|
|
|
62
63
|
技能已是最新版本 (v1.1.0),无需更新。
|
|
63
64
|
|
|
64
|
-
#
|
|
65
|
+
# 批量更新所有已安装技能(--prune 同时清理已下架技能的历史记录)
|
|
65
66
|
$ getskill update --all
|
|
67
|
+
$ getskill update --all --prune
|
|
68
|
+
|
|
69
|
+
批量更新完成:1/1 个技能成功。
|
|
66
70
|
|
|
67
71
|
# 查看某个技能的安装状态
|
|
68
|
-
$ getskill inspect pdf-
|
|
72
|
+
$ getskill inspect pdf-toolkit
|
|
69
73
|
|
|
70
|
-
#
|
|
74
|
+
# 查看 Agent 与目录路径
|
|
71
75
|
$ getskill path
|
|
72
76
|
|
|
73
|
-
|
|
74
|
-
|
|
77
|
+
Agent: claude (Claude Code)
|
|
78
|
+
技能目录: ~/.claude/skills
|
|
79
|
+
缓存目录: ~/.getskill/cache
|
|
80
|
+
配置文件: ~/.getskill/config.json
|
|
81
|
+
状态文件: ~/.getskill/state.json
|
|
82
|
+
站点地址: https://getskill.work
|
|
75
83
|
|
|
76
84
|
# 清理 ZIP 下载/解压缓存
|
|
77
85
|
$ getskill clean
|
|
78
86
|
|
|
79
|
-
已清理缓存目录: ~/.
|
|
87
|
+
已清理缓存目录: ~/.getskill/cache
|
|
80
88
|
```
|
|
81
89
|
|
|
82
90
|
## 场景 3: JSON 输出与脚本集成
|
|
@@ -156,26 +164,7 @@ const getskill = require('@workskills/getskill');
|
|
|
156
164
|
})();
|
|
157
165
|
```
|
|
158
166
|
|
|
159
|
-
## 场景 5:
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
$ getskill publish ./my-skill --repo https://github.com/<user>/my-skill.git
|
|
163
|
-
|
|
164
|
-
校验 SKILL.md...
|
|
165
|
-
初始化 Git 仓库...
|
|
166
|
-
提交并推送到 main 分支...
|
|
167
|
-
发布成功: https://github.com/<user>/my-skill
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
可选参数:
|
|
171
|
-
|
|
172
|
-
```bash
|
|
173
|
-
getskill publish <目录> --repo <git-url> --branch <name> --message <text>
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
> `SKILL.md` 缺失或不符合规范(缺少 front matter、`metadata`、`## 指令` 等关键结构)时,发布会被直接阻止。
|
|
177
|
-
|
|
178
|
-
## 场景 6: 错误处理
|
|
167
|
+
## 场景 5: 错误处理
|
|
179
168
|
|
|
180
169
|
```bash
|
|
181
170
|
# 技能不存在
|
|
@@ -191,48 +180,81 @@ $ getskill search pdf
|
|
|
191
180
|
提示: 尝试使用不同的关键词,或访问 https://getskill.work 查看所有可用技能
|
|
192
181
|
```
|
|
193
182
|
|
|
194
|
-
## 场景
|
|
183
|
+
## 场景 6: 切换 Agent / 自定义目录 / 自定义索引
|
|
195
184
|
|
|
196
185
|
```bash
|
|
197
|
-
#
|
|
186
|
+
# 查看当前生效配置(含来源)
|
|
198
187
|
$ getskill config get
|
|
199
|
-
当前 BASE_URL: https://getskill.work
|
|
200
188
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
189
|
+
base-url: https://getskill.work
|
|
190
|
+
来源: 默认值,未保存,使用默认站点
|
|
191
|
+
agent: claude (Claude Code)
|
|
192
|
+
来源: 自动识别,未保存,自动识别本机 Agent
|
|
193
|
+
skills-dir: ~/.claude/skills
|
|
194
|
+
来源: 自动识别,未单独保存,由 agent 推导
|
|
195
|
+
cache-dir: ~/.getskill/cache
|
|
196
|
+
来源: 默认值,未保存,使用默认缓存目录
|
|
197
|
+
配置文件: ~/.getskill/config.json
|
|
198
|
+
状态文件: ~/.getskill/state.json
|
|
199
|
+
|
|
200
|
+
# 列出内置 Agent 预设
|
|
201
|
+
$ getskill agents
|
|
202
|
+
|
|
203
|
+
# 切换到其它 Agent(持久化)
|
|
204
|
+
$ getskill config set agent cursor
|
|
205
|
+
agent: cursor (Cursor)
|
|
206
|
+
来源: 配置文件,已保存: cursor
|
|
207
|
+
|
|
208
|
+
# 任意 Agent:直接指定技能目录(持久化)
|
|
209
|
+
$ getskill config set skills-dir ~/.my-agent/skills
|
|
210
|
+
|
|
211
|
+
# 只对本次命令生效
|
|
212
|
+
$ getskill --agent codex install pdf-toolkit
|
|
213
|
+
$ getskill --skills-dir ~/.my-agent/skills install pdf-toolkit
|
|
214
|
+
|
|
215
|
+
# 删除配置项,恢复自动识别/默认值
|
|
216
|
+
$ getskill config unset agent
|
|
217
|
+
|
|
218
|
+
# 自定义索引地址(需要同样提供 /data/skills.json 与 /skills/<id>.zip)
|
|
219
|
+
$ getskill config set base-url https://custom-index.example.com
|
|
204
220
|
|
|
205
221
|
# 通过环境变量临时覆盖
|
|
206
222
|
$ GETSKILL_BASE_URL=https://another-index.com getskill search pdf
|
|
207
223
|
```
|
|
208
224
|
|
|
209
|
-
## 场景
|
|
225
|
+
## 场景 7: 目录结构查看
|
|
210
226
|
|
|
211
227
|
```bash
|
|
212
|
-
$ tree ~/.
|
|
213
|
-
|
|
214
|
-
~/.
|
|
215
|
-
├──
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
└──
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
228
|
+
$ tree ~/.getskill
|
|
229
|
+
|
|
230
|
+
~/.getskill/
|
|
231
|
+
├── config.json # 持久化配置
|
|
232
|
+
├── state.json # 安装记录(技能名、版本、安装目录)
|
|
233
|
+
└── cache/
|
|
234
|
+
└── pdf-toolkit/ # ZIP 解压后的技能包内容
|
|
235
|
+
└── pdf-toolkit/
|
|
236
|
+
└── SKILL.md
|
|
237
|
+
|
|
238
|
+
$ tree ~/.claude/skills # 当前 Agent 的技能目录
|
|
239
|
+
|
|
240
|
+
~/.claude/skills/
|
|
241
|
+
└── pdf-toolkit/
|
|
242
|
+
└── SKILL.md
|
|
225
243
|
```
|
|
226
244
|
|
|
227
245
|
## 常见问题
|
|
228
246
|
|
|
229
|
-
### Q:
|
|
247
|
+
### Q: 需要安装 Git 吗?
|
|
248
|
+
|
|
249
|
+
A: 不需要。搜索、安装、更新、卸载均通过 HTTP 直接下载 ZIP 并本地解压完成,全程不依赖 Git。
|
|
230
250
|
|
|
231
|
-
|
|
251
|
+
### Q: 我用的 Agent 不在预设列表里怎么办?
|
|
252
|
+
|
|
253
|
+
A: 用 `getskill config set skills-dir <path>`、`getskill --skills-dir <path> ...` 或 `GETSKILL_SKILLS_DIR=<path>` 指定该 Agent 的技能目录即可。
|
|
232
254
|
|
|
233
255
|
### Q: 如何卸载技能?
|
|
234
256
|
|
|
235
|
-
A: 使用 `getskill uninstall
|
|
257
|
+
A: 使用 `getskill uninstall <技能名称>`,或直接删除当前技能目录(`getskill path` 可查看)下对应的子目录。
|
|
236
258
|
|
|
237
259
|
### Q: 缓存目录可以删除吗?
|
|
238
260
|
|
|
@@ -241,3 +263,7 @@ A: 可以使用 `getskill clean` 清理缓存,下次安装/更新时会重新
|
|
|
241
263
|
### Q: 更新是如何判断的?
|
|
242
264
|
|
|
243
265
|
A: 安装时会在本地记录技能版本;`update` 时拉取远端索引中的最新版本号进行比较,不一致才重新下载。
|
|
266
|
+
|
|
267
|
+
### Q: `update --all` 提示某些技能“已跳过”是什么意思?
|
|
268
|
+
|
|
269
|
+
A: 说明这些技能已从索引中下架或改名,本地只剩下历史记录。执行 `getskill update --all --prune` 可以清理这些失效记录。
|