@workskills/getskill 1.1.10 → 1.2.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 +133 -184
- package/README.md +89 -107
- 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 -1
- package/dist/lib/skill-manager.js +83 -93
- package/dist/lib/state.d.ts +1 -1
- package/dist/lib/state.js +4 -4
- package/dist/lib/types.d.ts +24 -43
- package/dist/lib/unzip.d.ts +3 -0
- package/dist/lib/unzip.js +122 -0
- package/dist/main.js +35 -37
- package/package.json +1 -1
- package/dist/lib/publish-registry.d.ts +0 -15
- package/dist/lib/publish-registry.js +0 -334
package/README.md
CHANGED
|
@@ -4,23 +4,23 @@ OpenClaw 技能管理工具 - 从 getskill.work 搜索、下载和更新技能
|
|
|
4
4
|
|
|
5
5
|
## 功能特性
|
|
6
6
|
|
|
7
|
-
- 🔍 从 getskill.work
|
|
7
|
+
- 🔍 从 `getskill.work` 静态技能索引(`data/skills.json`)搜索技能
|
|
8
8
|
- 🧾 支持 JSON 格式搜索输出(`search --json`)
|
|
9
|
-
- 📥 通过 Git
|
|
10
|
-
- 🏷️ 支持安装/更新指定版本(`--version <
|
|
11
|
-
- 🔄
|
|
12
|
-
- 🚀
|
|
13
|
-
- 🛠️ 自动检测并引导安装 Git(如未安装)
|
|
9
|
+
- 📥 通过 HTTP 直接下载技能 ZIP 包,本地解压安装(**无需安装 Git**)
|
|
10
|
+
- 🏷️ 支持安装/更新指定版本(`--version <version>`)
|
|
11
|
+
- 🔄 基于版本号比较的增量更新(`update` / `update --all`)
|
|
12
|
+
- 🚀 支持将本地技能目录发布到自有 Git 远程仓库(`publish`)
|
|
14
13
|
- 📂 跨平台支持(Windows/macOS/Linux)
|
|
15
14
|
- 💾 自动管理技能文件到 OpenClaw skills 目录
|
|
16
|
-
- ⚙️
|
|
15
|
+
- ⚙️ 支持自定义索引地址
|
|
16
|
+
- 📦 零第三方运行时依赖(内置 ZIP 解析/解压实现)
|
|
17
17
|
|
|
18
18
|
## 工作原理
|
|
19
19
|
|
|
20
|
-
1. **搜索**:
|
|
21
|
-
2. **安装**:
|
|
22
|
-
3. **复制**:
|
|
23
|
-
4. **更新**:
|
|
20
|
+
1. **搜索**: 拉取 `https://getskill.work/data/skills.json` 静态索引,本地按关键词过滤
|
|
21
|
+
2. **安装**: 下载 `https://getskill.work/skills/<id>.zip` 到缓存目录并本地解压
|
|
22
|
+
3. **复制**: 将解压后的技能目录复制到 OpenClaw skills 目录,并记录版本信息
|
|
23
|
+
4. **更新**: 比较本地已安装版本与远端索引版本,不一致时重新下载解压
|
|
24
24
|
|
|
25
25
|
## 目录结构
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ OpenClaw 技能管理工具 - 从 getskill.work 搜索、下载和更新技能
|
|
|
29
29
|
├── skills/ # OpenClaw 技能目录
|
|
30
30
|
│ ├── skill1/
|
|
31
31
|
│ └── skill2/
|
|
32
|
-
└── skills-cache/ #
|
|
32
|
+
└── skills-cache/ # ZIP 下载与解压缓存
|
|
33
33
|
├── skill1/
|
|
34
34
|
└── skill2/
|
|
35
35
|
```
|
|
@@ -75,7 +75,7 @@ npm link
|
|
|
75
75
|
|
|
76
76
|
### 搜索技能
|
|
77
77
|
|
|
78
|
-
> `search` / `install` / `update` / `list` / `inspect` / `clean`
|
|
78
|
+
> `search` / `install` / `update` / `list` / `inspect` / `clean` **全部无需登录、无需 Git**。只有 `publish` 需要用户提供自己的 Git 远程仓库。
|
|
79
79
|
|
|
80
80
|
```bash
|
|
81
81
|
getskill search <关键词>
|
|
@@ -90,15 +90,17 @@ getskill search <关键词> --json
|
|
|
90
90
|
示例输出:
|
|
91
91
|
|
|
92
92
|
```
|
|
93
|
-
找到
|
|
93
|
+
找到 2 个技能:
|
|
94
94
|
|
|
95
|
-
1.
|
|
96
|
-
描述:
|
|
97
|
-
|
|
95
|
+
1. pdf-extract (v1.0.0)
|
|
96
|
+
描述: 从 PDF 文件中提取文本和表格
|
|
97
|
+
分类: 文档处理
|
|
98
|
+
下载: https://getskill.work/skills/pdf-extract.zip
|
|
98
99
|
|
|
99
|
-
2.
|
|
100
|
-
描述:
|
|
101
|
-
|
|
100
|
+
2. xlsx (v1.0.0)
|
|
101
|
+
描述: 电子表格文件的创建、编辑与分析
|
|
102
|
+
分类: 文档处理
|
|
103
|
+
下载: https://getskill.work/skills/xlsx.zip
|
|
102
104
|
```
|
|
103
105
|
|
|
104
106
|
### 安装技能
|
|
@@ -110,19 +112,20 @@ getskill install <技能名称>
|
|
|
110
112
|
安装指定版本:
|
|
111
113
|
|
|
112
114
|
```bash
|
|
113
|
-
getskill install <技能名称> --version <
|
|
115
|
+
getskill install <技能名称> --version <version>
|
|
114
116
|
```
|
|
115
117
|
|
|
116
118
|
示例:
|
|
117
119
|
|
|
118
120
|
```bash
|
|
119
|
-
getskill install
|
|
121
|
+
getskill install pdf-extract
|
|
120
122
|
```
|
|
121
123
|
|
|
122
124
|
操作流程:
|
|
123
125
|
|
|
124
|
-
1.
|
|
125
|
-
2.
|
|
126
|
+
1. 在静态索引中定位技能条目,获取 `download_url`
|
|
127
|
+
2. 下载 ZIP 包到 `~/.openclaw/skills-cache/<技能名称>` 并解压
|
|
128
|
+
3. 将技能目录复制到 `~/.openclaw/skills/<技能名称>`,记录已安装版本
|
|
126
129
|
|
|
127
130
|
### 更新技能
|
|
128
131
|
|
|
@@ -130,12 +133,6 @@ getskill install commit-helper
|
|
|
130
133
|
getskill update <技能名称>
|
|
131
134
|
```
|
|
132
135
|
|
|
133
|
-
示例:
|
|
134
|
-
|
|
135
|
-
```bash
|
|
136
|
-
getskill update commit-helper
|
|
137
|
-
```
|
|
138
|
-
|
|
139
136
|
批量更新所有已安装技能:
|
|
140
137
|
|
|
141
138
|
```bash
|
|
@@ -145,14 +142,14 @@ getskill update --all
|
|
|
145
142
|
切换到指定版本:
|
|
146
143
|
|
|
147
144
|
```bash
|
|
148
|
-
getskill update <技能名称> --version <
|
|
145
|
+
getskill update <技能名称> --version <version>
|
|
149
146
|
```
|
|
150
147
|
|
|
151
|
-
|
|
148
|
+
更新逻辑:
|
|
152
149
|
|
|
153
|
-
1.
|
|
154
|
-
2.
|
|
155
|
-
3.
|
|
150
|
+
1. 读取本地已安装技能的版本记录
|
|
151
|
+
2. 拉取远端索引中的最新版本号
|
|
152
|
+
3. 版本一致时提示"已是最新版本";不一致时重新下载 ZIP 并覆盖安装
|
|
156
153
|
|
|
157
154
|
### 卸载技能
|
|
158
155
|
|
|
@@ -163,7 +160,7 @@ getskill uninstall <技能名称>
|
|
|
163
160
|
仅卸载本地技能目录、保留缓存:
|
|
164
161
|
|
|
165
162
|
```bash
|
|
166
|
-
getskill uninstall
|
|
163
|
+
getskill uninstall <技能名称> --keep-cache
|
|
167
164
|
```
|
|
168
165
|
|
|
169
166
|
### 查看安装状态
|
|
@@ -174,34 +171,26 @@ getskill inspect <技能名称>
|
|
|
174
171
|
|
|
175
172
|
### 发布技能目录
|
|
176
173
|
|
|
174
|
+
`publish` 将本地技能目录提交并推送到**你自己的 Git 远程仓库**(如 GitHub):
|
|
175
|
+
|
|
177
176
|
```bash
|
|
178
|
-
getskill publish <目录>
|
|
177
|
+
getskill publish <目录> --repo <git-url>
|
|
179
178
|
```
|
|
180
179
|
|
|
181
180
|
默认行为:
|
|
182
181
|
|
|
183
182
|
1. 检查目录中是否存在 `SKILL.md`
|
|
184
183
|
2. 严格校验 `SKILL.md` 是否包含合法 front matter 和必要章节
|
|
185
|
-
3.
|
|
186
|
-
4. 自动在 `getskill.work` 创建同名仓库(若不存在)
|
|
187
|
-
5. 提交并推送到远程仓库
|
|
188
|
-
|
|
189
|
-
也可以显式指定仓库:
|
|
190
|
-
|
|
191
|
-
```bash
|
|
192
|
-
getskill publish <目录> --repo <git-url>
|
|
193
|
-
getskill publish <目录> --name <repo-name>
|
|
194
|
-
```
|
|
184
|
+
3. 初始化/提交本地 Git 仓库,并推送到指定远程
|
|
195
185
|
|
|
196
186
|
可选参数:
|
|
197
187
|
|
|
188
|
+
- `--repo <git-url>`: 远程仓库地址(必填)
|
|
198
189
|
- `--branch <name>`: 发布分支(默认 `main`)
|
|
199
190
|
- `--message <text>`: 自定义提交信息
|
|
200
|
-
- `--name <repo-name>`: 指定自动创建的仓库名称
|
|
201
|
-
- `--username <name>` / `--email <mail>` / `--password <pwd>`: 非交互发布时提供注册/登录信息
|
|
202
|
-
- `--private`: 创建私有仓库
|
|
203
191
|
|
|
204
192
|
> 如果 `SKILL.md` 缺失,或不符合规范(缺少 front matter、`metadata`、`## 指令` 等关键结构),发布会被直接阻止。
|
|
193
|
+
> 官方索引(getskill.work)当前不接受自助发布,收录请联系站点维护者。
|
|
205
194
|
|
|
206
195
|
### 列出本地技能
|
|
207
196
|
|
|
@@ -223,70 +212,84 @@ getskill path
|
|
|
223
212
|
getskill clean
|
|
224
213
|
```
|
|
225
214
|
|
|
226
|
-
|
|
215
|
+
清理 ZIP 下载与解压缓存(不影响 skills 目录中的文件)
|
|
227
216
|
|
|
228
|
-
###
|
|
217
|
+
### 配置索引地址
|
|
229
218
|
|
|
230
|
-
|
|
219
|
+
查看当前索引地址:
|
|
231
220
|
|
|
232
221
|
```bash
|
|
233
222
|
getskill config get
|
|
234
223
|
```
|
|
235
224
|
|
|
236
|
-
|
|
225
|
+
设置自定义索引地址:
|
|
237
226
|
|
|
238
227
|
```bash
|
|
239
|
-
getskill config set https://your-custom-
|
|
228
|
+
getskill config set https://your-custom-index.com
|
|
240
229
|
```
|
|
241
230
|
|
|
242
231
|
通过环境变量设置:
|
|
243
232
|
|
|
244
233
|
```bash
|
|
245
|
-
GETSKILL_BASE_URL=https://your-custom-
|
|
234
|
+
GETSKILL_BASE_URL=https://your-custom-index.com getskill search keyword
|
|
246
235
|
```
|
|
247
236
|
|
|
248
|
-
##
|
|
237
|
+
## 索引数据规范
|
|
249
238
|
|
|
250
|
-
###
|
|
239
|
+
### 索引文件
|
|
251
240
|
|
|
252
241
|
```
|
|
253
|
-
GET https://getskill.work/
|
|
242
|
+
GET https://getskill.work/data/skills.json
|
|
254
243
|
```
|
|
255
244
|
|
|
256
245
|
响应格式:
|
|
257
246
|
|
|
258
247
|
```json
|
|
259
248
|
{
|
|
260
|
-
"
|
|
261
|
-
"
|
|
249
|
+
"updated": "2026-11-20",
|
|
250
|
+
"skills": [
|
|
262
251
|
{
|
|
263
|
-
"id":
|
|
264
|
-
"
|
|
265
|
-
"description": "
|
|
266
|
-
"
|
|
267
|
-
"
|
|
252
|
+
"id": "pdf-extract",
|
|
253
|
+
"name": "pdf-extract",
|
|
254
|
+
"description": "从 PDF 文件中提取文本和表格",
|
|
255
|
+
"category": "文档处理",
|
|
256
|
+
"tags": ["pdf", "提取"],
|
|
257
|
+
"version": "1.0.0",
|
|
258
|
+
"author": "Anthropic",
|
|
259
|
+
"updated": "2026-11-20",
|
|
260
|
+
"file": "skills/pdf-extract.zip",
|
|
261
|
+
"size": 173410,
|
|
262
|
+
"source": "https://github.com/anthropics/skills"
|
|
268
263
|
}
|
|
269
264
|
]
|
|
270
265
|
}
|
|
271
266
|
```
|
|
272
267
|
|
|
268
|
+
### 技能 ZIP 包
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
GET https://getskill.work/skills/<id>.zip
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
ZIP 包根目录(或唯一包装目录)下应包含 `SKILL.md` 及配套文件。
|
|
275
|
+
|
|
273
276
|
## 编程接口
|
|
274
277
|
|
|
275
278
|
```javascript
|
|
276
279
|
const getskill = require('@workskills/getskill');
|
|
277
280
|
|
|
278
|
-
//
|
|
279
|
-
getskill.setBaseUrl('https://your-custom-
|
|
281
|
+
// 设置自定义索引地址(可选)
|
|
282
|
+
getskill.setBaseUrl('https://your-custom-index.com');
|
|
280
283
|
|
|
281
|
-
//
|
|
282
|
-
const results = await getskill.searchSkills('
|
|
284
|
+
// 搜索技能(基于静态索引)
|
|
285
|
+
const results = await getskill.searchSkills('pdf');
|
|
283
286
|
|
|
284
|
-
//
|
|
285
|
-
const result = await getskill.downloadSkill('
|
|
287
|
+
// 安装技能(下载 ZIP + 解压 + 复制)
|
|
288
|
+
const result = await getskill.downloadSkill('pdf-extract');
|
|
286
289
|
console.log(result.files); // 已复制的技能目录列表
|
|
287
290
|
|
|
288
|
-
//
|
|
289
|
-
await getskill.updateSkill('
|
|
291
|
+
// 更新技能(版本比较)
|
|
292
|
+
await getskill.updateSkill('pdf-extract');
|
|
290
293
|
|
|
291
294
|
// 列出本地技能
|
|
292
295
|
const skills = getskill.listLocalSkills();
|
|
@@ -295,32 +298,33 @@ const skills = getskill.listLocalSkills();
|
|
|
295
298
|
const skillsDir = getskill.getSkillsDirectory();
|
|
296
299
|
const cacheDir = getskill.getSkillsCacheDirectory();
|
|
297
300
|
|
|
298
|
-
//
|
|
301
|
+
// 获取当前索引地址
|
|
299
302
|
const baseUrl = getskill.getBaseUrl();
|
|
300
303
|
```
|
|
301
304
|
|
|
302
|
-
##
|
|
305
|
+
## 技能包规范
|
|
303
306
|
|
|
304
|
-
技能
|
|
307
|
+
技能 ZIP 包应包含:
|
|
305
308
|
|
|
306
|
-
-
|
|
309
|
+
- `SKILL.md` 技能定义文件(含 front matter 与指令内容)
|
|
307
310
|
- 可选的 `README.md` 说明文档
|
|
308
|
-
-
|
|
311
|
+
- 可选的示例代码、脚本或配置文件
|
|
309
312
|
|
|
310
313
|
示例结构:
|
|
311
314
|
|
|
312
315
|
```
|
|
313
|
-
|
|
314
|
-
├──
|
|
315
|
-
├── README.md
|
|
316
|
-
|
|
316
|
+
pdf-extract/
|
|
317
|
+
├── SKILL.md # 技能定义文件(必需)
|
|
318
|
+
├── README.md # 说明文档(可选,会随目录复制)
|
|
319
|
+
├── scripts/ # 脚本(可选,会随目录复制)
|
|
320
|
+
└── examples/ # 示例(可选,会随目录复制)
|
|
317
321
|
```
|
|
318
322
|
|
|
319
323
|
## 依赖
|
|
320
324
|
|
|
321
325
|
- Node.js >= 12(运行 CLI)
|
|
322
326
|
- Node.js 18+(开发与测试工具)
|
|
323
|
-
- Git
|
|
327
|
+
- Git 命令行工具(仅 `publish` 命令需要;搜索/安装/更新均不依赖 Git)
|
|
324
328
|
|
|
325
329
|
## 开发与质量保障
|
|
326
330
|
|
|
@@ -340,32 +344,10 @@ npm run coverage
|
|
|
340
344
|
- [`CONTRIBUTING.md`](CONTRIBUTING.md)
|
|
341
345
|
- [`docs/architecture.md`](docs/architecture.md)
|
|
342
346
|
|
|
343
|
-
## Git 自动检测与安装
|
|
344
|
-
|
|
345
|
-
首次运行 `install` 或 `update` 命令时,程序会自动检测系统是否已安装 Git:
|
|
346
|
-
|
|
347
|
-
### Windows
|
|
348
|
-
|
|
349
|
-
- **自动下载**: 自动下载 Git 安装程序并启动安装向导
|
|
350
|
-
- **手动安装**: 如果自动下载失败,会提示访问 https://git-scm.com/download/win
|
|
351
|
-
|
|
352
|
-
### macOS
|
|
353
|
-
|
|
354
|
-
- 提示使用 Homebrew 安装:`brew install git`
|
|
355
|
-
- 如未安装 Homebrew,会提示访问 https://brew.sh/
|
|
356
|
-
|
|
357
|
-
### Linux
|
|
358
|
-
|
|
359
|
-
- 提示使用系统包管理器安装:
|
|
360
|
-
- Ubuntu/Debian: `sudo apt-get install git`
|
|
361
|
-
- CentOS/RHEL: `sudo yum install git`
|
|
362
|
-
- Fedora: `sudo dnf install git`
|
|
363
|
-
- Arch: `sudo pacman -S git`
|
|
364
|
-
|
|
365
347
|
## 许可证
|
|
366
348
|
|
|
367
349
|
MIT
|
|
368
350
|
|
|
369
351
|
## 作者
|
|
370
352
|
|
|
371
|
-
|
|
353
|
+
getskill.work
|
package/dist/lib/config.d.ts
CHANGED
|
@@ -7,4 +7,3 @@ export declare function getSkillsDirectory(): string;
|
|
|
7
7
|
export declare function getSkillsCacheDirectory(): string;
|
|
8
8
|
export declare function getGetSkillConfigDirectory(): string;
|
|
9
9
|
export declare function getStateFilePath(): string;
|
|
10
|
-
export declare function getAuthFilePath(): string;
|
package/dist/lib/config.js
CHANGED
|
@@ -11,7 +11,6 @@ exports.getSkillsDirectory = getSkillsDirectory;
|
|
|
11
11
|
exports.getSkillsCacheDirectory = getSkillsCacheDirectory;
|
|
12
12
|
exports.getGetSkillConfigDirectory = getGetSkillConfigDirectory;
|
|
13
13
|
exports.getStateFilePath = getStateFilePath;
|
|
14
|
-
exports.getAuthFilePath = getAuthFilePath;
|
|
15
14
|
const os_1 = __importDefault(require("os"));
|
|
16
15
|
const path_1 = __importDefault(require("path"));
|
|
17
16
|
let baseUrl = process.env.GETSKILL_BASE_URL || 'https://getskill.work';
|
|
@@ -42,6 +41,3 @@ function getGetSkillConfigDirectory() {
|
|
|
42
41
|
function getStateFilePath() {
|
|
43
42
|
return path_1.default.join(getGetSkillConfigDirectory(), 'state.json');
|
|
44
43
|
}
|
|
45
|
-
function getAuthFilePath() {
|
|
46
|
-
return path_1.default.join(getGetSkillConfigDirectory(), 'auth.json');
|
|
47
|
-
}
|
package/dist/lib/network.d.ts
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
|
-
import type { RequestOptions, RequestResponse,
|
|
1
|
+
import type { RequestOptions, RequestResponse, SearchOptions, SearchSkill, SkillIndexEntry } from './types';
|
|
2
2
|
export declare function request(url: string, options?: RequestOptions, redirectCount?: number): Promise<RequestResponse>;
|
|
3
|
-
export declare function
|
|
4
|
-
export declare function
|
|
3
|
+
export declare function downloadFile(url: string, destPath: string, redirectCount?: number): Promise<number>;
|
|
4
|
+
export declare function getSkillsIndexUrl(): string;
|
|
5
|
+
export declare function getSkillPackageUrl(entry: SkillIndexEntry): string;
|
|
6
|
+
export declare function fetchSkillsIndex(): Promise<SkillIndexEntry[]>;
|
|
7
|
+
export declare function normalizeSkillIndexKey(skillName: string): string;
|
|
8
|
+
export declare function filterIndexByKeyword(entries: SkillIndexEntry[], keyword: string, limit?: number, page?: number): SkillIndexEntry[];
|
|
9
|
+
export declare function mapIndexEntryToSearchSkill(entry: SkillIndexEntry): SearchSkill;
|
|
10
|
+
export declare function findSkillIndexEntry(skillName: string): Promise<SkillIndexEntry | null>;
|
|
11
|
+
export declare function repositoryHasSkillFile(skillName: string): Promise<boolean>;
|
|
5
12
|
export declare function searchSkills(keyword: string, options?: SearchOptions): Promise<SearchSkill[]>;
|