@workskills/getskill 1.1.10 → 2.0.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 +119 -189
- package/README.md +77 -127
- package/dist/lib/config.d.ts +0 -1
- package/dist/lib/config.js +0 -4
- package/dist/lib/network.d.ts +10 -3
- package/dist/lib/network.js +214 -68
- package/dist/lib/skill-manager.d.ts +7 -2
- package/dist/lib/skill-manager.js +71 -192
- package/dist/lib/state.d.ts +1 -1
- package/dist/lib/state.js +4 -4
- package/dist/lib/system.d.ts +0 -6
- package/dist/lib/system.js +0 -159
- package/dist/lib/types.d.ts +24 -71
- package/dist/lib/unzip.d.ts +3 -0
- package/dist/lib/unzip.js +122 -0
- package/dist/main.d.ts +2 -3
- package/dist/main.js +32 -79
- package/package.json +1 -2
- package/dist/lib/publish-registry.d.ts +0 -15
- package/dist/lib/publish-registry.js +0 -334
- package/dist/lib/skill-validator.d.ts +0 -4
- package/dist/lib/skill-validator.js +0 -107
package/EXAMPLES.md
CHANGED
|
@@ -1,175 +1,151 @@
|
|
|
1
1
|
# GetSkill 使用示例
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> 当前版本基于 `getskill.work` 静态索引 + ZIP 包下载,提供**搜索、下载(安装)、更新**三大核心功能,全部**无需 Git、无需登录**。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## 场景 1: 搜索并安装技能
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
#
|
|
9
|
-
$ getskill
|
|
10
|
-
|
|
11
|
-
检测到系统未安装 Git,正在准备安装...
|
|
12
|
-
|
|
13
|
-
Windows 系统检测到未安装 Git
|
|
14
|
-
正在下载 Git 安装程序...
|
|
15
|
-
|
|
16
|
-
下载进度: 100%
|
|
17
|
-
下载完成!
|
|
8
|
+
# 搜索技能
|
|
9
|
+
$ getskill search pdf
|
|
18
10
|
|
|
19
|
-
|
|
11
|
+
找到 1 个技能:
|
|
20
12
|
|
|
21
|
-
|
|
22
|
-
|
|
13
|
+
1. pdf-extract (v1.0.0)
|
|
14
|
+
描述: 从 PDF 文件中提取文本和表格
|
|
15
|
+
分类: 文档处理
|
|
16
|
+
下载: https://getskill.work/skills/pdf-extract.zip
|
|
23
17
|
|
|
24
|
-
#
|
|
25
|
-
$ getskill install
|
|
18
|
+
# 安装技能
|
|
19
|
+
$ getskill install pdf-extract
|
|
26
20
|
|
|
27
|
-
下载技能:
|
|
28
|
-
|
|
29
|
-
|
|
21
|
+
下载技能: pdf-extract...
|
|
22
|
+
下载技能包: https://getskill.work/skills/pdf-extract.zip
|
|
23
|
+
下载完成 (173410 bytes),正在解压...
|
|
24
|
+
技能包已解压: ~/.openclaw/skills-cache/pdf-extract
|
|
25
|
+
技能 pdf-extract (v1.0.0) 安装成功!
|
|
30
26
|
|
|
31
27
|
技能已安装到 skills 目录:
|
|
32
|
-
-
|
|
28
|
+
- ~/.openclaw/skills/pdf-extract
|
|
33
29
|
|
|
34
|
-
|
|
30
|
+
本地缓存: ~/.openclaw/skills-cache/pdf-extract
|
|
31
|
+
已安装版本: 1.0.0
|
|
35
32
|
```
|
|
36
33
|
|
|
37
|
-
|
|
34
|
+
## 场景 2: 日常使用流程
|
|
38
35
|
|
|
39
36
|
```bash
|
|
40
|
-
|
|
37
|
+
# 列出已安装的技能
|
|
38
|
+
$ getskill list
|
|
41
39
|
|
|
42
|
-
|
|
40
|
+
本地已安装的技能 (1):
|
|
41
|
+
1. pdf-extract
|
|
43
42
|
|
|
44
|
-
|
|
45
|
-
|
|
43
|
+
# 检查更新(版本比较)
|
|
44
|
+
$ getskill update pdf-extract
|
|
46
45
|
|
|
47
|
-
|
|
46
|
+
正在更新技能: pdf-extract...
|
|
47
|
+
发现新版本: 1.0.0 -> 1.1.0
|
|
48
|
+
下载技能包: https://getskill.work/skills/pdf-extract.zip
|
|
49
|
+
下载完成 (175000 bytes),正在解压...
|
|
50
|
+
技能 pdf-extract 更新成功!
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
技能已更新到 skills 目录:
|
|
53
|
+
- ~/.openclaw/skills/pdf-extract
|
|
54
|
+
当前版本: 1.1.0
|
|
50
55
|
|
|
51
|
-
#
|
|
52
|
-
$
|
|
56
|
+
# 已是最新时
|
|
57
|
+
$ getskill update pdf-extract
|
|
53
58
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
✓ 安装成功
|
|
57
|
-
```
|
|
59
|
+
正在更新技能: pdf-extract...
|
|
60
|
+
技能 pdf-extract 已是最新版本 (1.1.0),无需更新
|
|
58
61
|
|
|
59
|
-
|
|
62
|
+
技能已是最新版本 (v1.1.0),无需更新。
|
|
60
63
|
|
|
61
|
-
|
|
62
|
-
$ getskill
|
|
64
|
+
# 批量更新所有已安装技能
|
|
65
|
+
$ getskill update --all
|
|
63
66
|
|
|
64
|
-
|
|
67
|
+
# 查看某个技能的安装状态
|
|
68
|
+
$ getskill inspect pdf-extract
|
|
65
69
|
|
|
66
|
-
|
|
67
|
-
|
|
70
|
+
# 查看目录路径
|
|
71
|
+
$ getskill path
|
|
68
72
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
Fedora: sudo dnf install git
|
|
72
|
-
Arch: sudo pacman -S git
|
|
73
|
+
技能目录: ~/.openclaw/skills
|
|
74
|
+
缓存目录: ~/.openclaw/skills-cache
|
|
73
75
|
|
|
74
|
-
#
|
|
75
|
-
$
|
|
76
|
+
# 清理 ZIP 下载/解压缓存
|
|
77
|
+
$ getskill clean
|
|
76
78
|
|
|
77
|
-
|
|
78
|
-
$ getskill install commit-helper
|
|
79
|
-
✓ 安装成功
|
|
79
|
+
已清理缓存目录: ~/.openclaw/skills-cache
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
## 场景
|
|
82
|
+
## 场景 3: JSON 输出与脚本集成
|
|
83
83
|
|
|
84
84
|
```bash
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
- ~/.openclaw/skills/commit-helper
|
|
108
|
-
|
|
109
|
-
Git 仓库缓存: ~/.openclaw/skills-cache/commit-helper
|
|
110
|
-
|
|
111
|
-
# 列出已安装的技能
|
|
112
|
-
$ getskill list
|
|
113
|
-
|
|
114
|
-
本地已安装的技能 (1):
|
|
115
|
-
1. commit-helper
|
|
116
|
-
|
|
117
|
-
# 更新技能
|
|
118
|
-
$ getskill update commit-helper
|
|
119
|
-
|
|
120
|
-
正在更新技能: commit-helper...
|
|
121
|
-
Git 仓库已更新
|
|
122
|
-
Already up to date.
|
|
123
|
-
已复制技能目录: ~/.openclaw/skills-cache/commit-helper -> ~/.openclaw/skills/commit-helper
|
|
124
|
-
|
|
125
|
-
技能已更新到 skills 目录:
|
|
126
|
-
- ~/.openclaw/skills/commit-helper
|
|
127
|
-
|
|
128
|
-
# 查看目录路径
|
|
129
|
-
$ getskill path
|
|
85
|
+
$ getskill search xlsx --json
|
|
86
|
+
|
|
87
|
+
{
|
|
88
|
+
"keyword": "xlsx",
|
|
89
|
+
"count": 1,
|
|
90
|
+
"results": [
|
|
91
|
+
{
|
|
92
|
+
"name": "xlsx",
|
|
93
|
+
"full_name": "xlsx",
|
|
94
|
+
"description": "...",
|
|
95
|
+
"html_url": "https://getskill.work/skill.html?id=xlsx",
|
|
96
|
+
"git_url": "https://getskill.work/skills/xlsx.zip",
|
|
97
|
+
"clone_url": "https://getskill.work/skills/xlsx.zip",
|
|
98
|
+
"download_url": "https://getskill.work/skills/xlsx.zip",
|
|
99
|
+
"version": "1.0.0",
|
|
100
|
+
"category": "文档处理",
|
|
101
|
+
"author": "Anthropic",
|
|
102
|
+
"size": 173410
|
|
103
|
+
}
|
|
104
|
+
]
|
|
105
|
+
}
|
|
106
|
+
```
|
|
130
107
|
|
|
131
|
-
|
|
132
|
-
缓存目录: ~/.openclaw/skills-cache
|
|
108
|
+
批量安装脚本:
|
|
133
109
|
|
|
134
|
-
|
|
135
|
-
|
|
110
|
+
```bash
|
|
111
|
+
#!/bin/bash
|
|
112
|
+
skills=(
|
|
113
|
+
"pdf-extract"
|
|
114
|
+
"xlsx"
|
|
115
|
+
"docx"
|
|
116
|
+
)
|
|
136
117
|
|
|
137
|
-
|
|
118
|
+
for skill in "${skills[@]}"; do
|
|
119
|
+
echo "正在安装: $skill"
|
|
120
|
+
getskill install "$skill"
|
|
121
|
+
echo "---"
|
|
122
|
+
done
|
|
138
123
|
```
|
|
139
124
|
|
|
140
|
-
## 场景
|
|
125
|
+
## 场景 4: 编程接口使用
|
|
141
126
|
|
|
142
127
|
```javascript
|
|
143
128
|
const getskill = require('@workskills/getskill');
|
|
144
129
|
|
|
145
130
|
(async () => {
|
|
146
131
|
try {
|
|
147
|
-
//
|
|
132
|
+
// 设置自定义索引地址(可选)
|
|
148
133
|
getskill.setBaseUrl('https://getskill.work');
|
|
149
134
|
|
|
150
|
-
//
|
|
151
|
-
console.log('
|
|
152
|
-
|
|
153
|
-
// 检查 Git 是否已安装
|
|
154
|
-
const isGitInstalled = await getskill.checkGitInstalled();
|
|
155
|
-
console.log('Git 已安装:', isGitInstalled);
|
|
156
|
-
|
|
157
|
-
if (!isGitInstalled) {
|
|
158
|
-
console.log('正在引导安装 Git...');
|
|
159
|
-
await getskill.ensureGitInstalled();
|
|
160
|
-
}
|
|
135
|
+
// 查看当前索引地址
|
|
136
|
+
console.log('当前索引:', getskill.getBaseUrl());
|
|
161
137
|
|
|
162
|
-
//
|
|
163
|
-
const results = await getskill.searchSkills('
|
|
138
|
+
// 搜索技能(基于静态索引 data/skills.json)
|
|
139
|
+
const results = await getskill.searchSkills('pdf');
|
|
164
140
|
console.log('搜索结果:', results);
|
|
165
141
|
|
|
166
|
-
//
|
|
167
|
-
const result = await getskill.downloadSkill('
|
|
142
|
+
// 安装技能(下载 ZIP + 本地解压 + 复制)
|
|
143
|
+
const result = await getskill.downloadSkill('pdf-extract');
|
|
168
144
|
console.log('安装成功:', result.files);
|
|
169
145
|
|
|
170
|
-
//
|
|
171
|
-
await getskill.updateSkill('
|
|
172
|
-
console.log('
|
|
146
|
+
// 更新技能(版本比较)
|
|
147
|
+
await getskill.updateSkill('pdf-extract');
|
|
148
|
+
console.log('更新检查完成');
|
|
173
149
|
|
|
174
150
|
// 列出本地技能
|
|
175
151
|
const localSkills = getskill.listLocalSkills();
|
|
@@ -180,30 +156,6 @@ const getskill = require('@workskills/getskill');
|
|
|
180
156
|
})();
|
|
181
157
|
```
|
|
182
158
|
|
|
183
|
-
## 场景 4: 批量安装技能
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
# 创建脚本 install-skills.sh
|
|
187
|
-
#!/bin/bash
|
|
188
|
-
|
|
189
|
-
skills=(
|
|
190
|
-
"commit-helper"
|
|
191
|
-
"code-review"
|
|
192
|
-
"test-generator"
|
|
193
|
-
"doc-writer"
|
|
194
|
-
)
|
|
195
|
-
|
|
196
|
-
for skill in "${skills[@]}"; do
|
|
197
|
-
echo "正在安装: $skill"
|
|
198
|
-
getskill install "$skill"
|
|
199
|
-
echo "---"
|
|
200
|
-
done
|
|
201
|
-
|
|
202
|
-
# 运行脚本
|
|
203
|
-
$ chmod +x install-skills.sh
|
|
204
|
-
$ ./install-skills.sh
|
|
205
|
-
```
|
|
206
|
-
|
|
207
159
|
## 场景 5: 错误处理
|
|
208
160
|
|
|
209
161
|
```bash
|
|
@@ -213,82 +165,60 @@ $ getskill install non-existent-skill
|
|
|
213
165
|
下载技能失败: 技能不存在: non-existent-skill
|
|
214
166
|
执行命令时出错: 技能不存在: non-existent-skill
|
|
215
167
|
|
|
216
|
-
# Git URL 无效
|
|
217
|
-
$ getskill install invalid-git-skill
|
|
218
|
-
下载技能: invalid-git-skill...
|
|
219
|
-
克隆仓库: https://getskill.work/skills/invalid-git-skill.git...
|
|
220
|
-
克隆失败: fatal: repository 'https://getskill.work/skills/invalid-git-skill.git/' not found
|
|
221
|
-
下载技能失败: Command failed: git clone...
|
|
222
|
-
执行命令时出错: Command failed: git clone...
|
|
223
|
-
|
|
224
168
|
# 网络问题
|
|
225
|
-
$ getskill search
|
|
169
|
+
$ getskill search pdf
|
|
226
170
|
搜索失败: 请求超时,请稍后重试
|
|
227
171
|
未找到相关技能
|
|
228
172
|
提示: 尝试使用不同的关键词,或访问 https://getskill.work 查看所有可用技能
|
|
229
173
|
```
|
|
230
174
|
|
|
231
|
-
## 场景 6:
|
|
175
|
+
## 场景 6: 配置自定义索引地址
|
|
232
176
|
|
|
233
177
|
```bash
|
|
234
|
-
#
|
|
178
|
+
# 查看当前索引地址
|
|
235
179
|
$ getskill config get
|
|
236
180
|
当前 BASE_URL: https://getskill.work
|
|
237
181
|
|
|
238
|
-
#
|
|
239
|
-
$ getskill config set https://custom-
|
|
240
|
-
BASE_URL 已设置为: https://custom-
|
|
182
|
+
# 设置自定义索引地址(需要同样提供 /data/skills.json 与 /skills/<id>.zip)
|
|
183
|
+
$ getskill config set https://custom-index.example.com
|
|
184
|
+
BASE_URL 已设置为: https://custom-index.example.com
|
|
241
185
|
|
|
242
|
-
#
|
|
243
|
-
$ GETSKILL_BASE_URL=https://another-
|
|
244
|
-
找到 2 个技能:
|
|
245
|
-
...
|
|
246
|
-
|
|
247
|
-
# 验证配置
|
|
248
|
-
$ getskill config get
|
|
249
|
-
当前 BASE_URL: https://custom-api.example.com
|
|
186
|
+
# 通过环境变量临时覆盖
|
|
187
|
+
$ GETSKILL_BASE_URL=https://another-index.com getskill search pdf
|
|
250
188
|
```
|
|
251
189
|
|
|
252
190
|
## 场景 7: 目录结构查看
|
|
253
191
|
|
|
254
192
|
```bash
|
|
255
|
-
# 安装几个技能后查看目录结构
|
|
256
193
|
$ tree ~/.openclaw
|
|
257
194
|
|
|
258
195
|
~/.openclaw/
|
|
259
196
|
├── skills/
|
|
260
|
-
│ ├──
|
|
261
|
-
│
|
|
262
|
-
│ └──
|
|
197
|
+
│ ├── pdf-extract/
|
|
198
|
+
│ │ └── SKILL.md
|
|
199
|
+
│ └── xlsx/
|
|
200
|
+
│ └── SKILL.md
|
|
263
201
|
└── skills-cache/
|
|
264
|
-
├──
|
|
265
|
-
│
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
├── code-review/
|
|
269
|
-
│ ├── code-review.md
|
|
270
|
-
│ ├── README.md
|
|
271
|
-
│ └── .git/
|
|
272
|
-
└── test-generator/
|
|
273
|
-
├── test-generator.md
|
|
274
|
-
├── README.md
|
|
275
|
-
└── .git/
|
|
202
|
+
├── pdf-extract/ # 解压后的技能包内容
|
|
203
|
+
│ └── SKILL.md
|
|
204
|
+
└── xlsx/
|
|
205
|
+
└── SKILL.md
|
|
276
206
|
```
|
|
277
207
|
|
|
278
208
|
## 常见问题
|
|
279
209
|
|
|
280
|
-
### Q: Git
|
|
210
|
+
### Q: 需要安装 Git 吗?
|
|
281
211
|
|
|
282
|
-
A:
|
|
212
|
+
A: 不需要。搜索、安装、更新、卸载均通过 HTTP 直接下载 ZIP 并本地解压完成,全程不依赖 Git。
|
|
283
213
|
|
|
284
214
|
### Q: 如何卸载技能?
|
|
285
215
|
|
|
286
|
-
A:
|
|
216
|
+
A: 使用 `getskill uninstall <技能名称>`,或直接删除 `~/.openclaw/skills/` 下对应目录。
|
|
287
217
|
|
|
288
218
|
### Q: 缓存目录可以删除吗?
|
|
289
219
|
|
|
290
|
-
A: 可以使用 `getskill clean`
|
|
220
|
+
A: 可以使用 `getskill clean` 清理缓存,下次安装/更新时会重新下载 ZIP。
|
|
291
221
|
|
|
292
|
-
### Q:
|
|
222
|
+
### Q: 更新是如何判断的?
|
|
293
223
|
|
|
294
|
-
A:
|
|
224
|
+
A: 安装时会在本地记录技能版本;`update` 时拉取远端索引中的最新版本号进行比较,不一致才重新下载。
|