@workskills/getskill 1.1.7 → 1.1.9

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 CHANGED
@@ -174,7 +174,6 @@ const getskill = require('@workskills/getskill');
174
174
  // 列出本地技能
175
175
  const localSkills = getskill.listLocalSkills();
176
176
  console.log('本地技能:', localSkills);
177
-
178
177
  } catch (error) {
179
178
  console.error('错误:', error.message);
180
179
  }
@@ -279,13 +278,17 @@ $ tree ~/.openclaw
279
278
  ## 常见问题
280
279
 
281
280
  ### Q: Git 安装后仍提示未安装?
281
+
282
282
  A: Windows 用户需要重启终端或系统,以便环境变量生效。
283
283
 
284
284
  ### Q: 如何卸载技能?
285
+
285
286
  A: 直接删除 `~/.openclaw/skills/` 目录下的对应技能目录即可。
286
287
 
287
288
  ### Q: 缓存目录可以删除吗?
289
+
288
290
  A: 可以使用 `getskill clean` 清理缓存,下次更新技能时会重新克隆。
289
291
 
290
292
  ### Q: 如何手动指定 Git 路径?
293
+
291
294
  A: 确保 `git` 命令在系统 PATH 中,或修改 `~/.bashrc` / `~/.zshrc` 添加 Git 路径。
package/README.md CHANGED
@@ -1,260 +1,371 @@
1
- # GetSkill
2
-
3
- OpenClaw 技能管理工具 - 从 getskill.work 搜索、下载和更新技能文件
4
-
5
- ## 功能特性
6
-
7
- - 🔍 从 getskill.work API 搜索技能
8
- - 📥 通过 Git 克隆技能仓库
9
- - 🔄 通过 Git pull 更新已安装的技能
10
- - 🛠️ 自动检测并引导安装 Git(如未安装)
11
- - 📂 跨平台支持(Windows/macOS/Linux)
12
- - 💾 自动管理技能文件到 OpenClaw skills 目录
13
- - ⚙️ 支持自定义 API 地址
14
-
15
- ## 工作原理
16
-
17
- 1. **搜索**: 从 `getskill.work` API 获取技能列表,包含 Git 仓库地址
18
- 2. **安装**: 使用 `git clone` 克隆技能仓库到缓存目录
19
- 3. **复制**: 将仓库目录(排除 `.git`)复制到 OpenClaw skills 目录
20
- 4. **更新**: 使用 `git pull` 更新仓库,并重新复制技能目录
21
-
22
- ## 目录结构
23
-
24
- ```
25
- ~/.openclaw/
26
- ├── skills/ # OpenClaw 技能目录
27
- │ ├── skill1/
28
- │ └── skill2/
29
- └── skills-cache/ # Git 仓库缓存
30
- ├── skill1/
31
- └── skill2/
32
- ```
33
-
34
- ### 平台路径
35
-
36
- - **Windows**: `%USERPROFILE%\.openclaw\skills`
37
- - **macOS**: `~/.openclaw/skills`
38
- - **Linux**: `~/.openclaw/skills`
39
-
40
- ## 安装
41
-
42
- ### 全局安装(推荐)
43
-
44
- ```bash
45
- npm install -g @workskills/getskill
46
- ```
47
-
48
- 安装后,可以在任何位置使用 `getskill` 命令。
49
-
50
- ### 本地安装
51
-
52
- ```bash
53
- npm install @workskills/getskill
54
- ```
55
-
56
- 本地安装后,可以通过 npx 运行:
57
-
58
- ```bash
59
- npx getskill search <关键词>
60
- ```
61
-
62
- ### 从源码安装
63
-
64
- ```bash
65
- git clone https://github.com/work-skills/getskill.git
66
- cd getskill
67
- npm install
68
- npm link
69
- ```
70
-
71
- ## 使用方法
72
-
73
- ### 搜索技能
74
-
75
- ```bash
76
- getskill search <关键词>
77
- ```
78
-
79
- 示例输出:
80
- ```
81
- 找到 3 个技能:
82
-
83
- 1. commit-helper
84
- 描述: 帮助生成规范的 git commit 信息
85
- Git: https://getskill.work/skills/commit-helper.git
86
-
87
- 2. code-review
88
- 描述: AI 代码审查助手
89
- Git: https://getskill.work/skills/code-review.git
90
- ```
91
-
92
- ### 安装技能
93
-
94
- ```bash
95
- getskill install <技能名称>
96
- ```
97
-
98
- 示例:
99
- ```bash
100
- getskill install commit-helper
101
- ```
102
-
103
- 操作流程:
104
- 1. 执行 `git clone` 到 `~/.openclaw/skills-cache/commit-helper`
105
- 2. 将整个技能目录复制到 `~/.openclaw/skills/commit-helper`
106
-
107
- ### 更新技能
108
-
109
- ```bash
110
- getskill update <技能名称>
111
- ```
112
-
113
- 示例:
114
- ```bash
115
- getskill update commit-helper
116
- ```
117
-
118
- 操作流程:
119
- 1. 进入缓存目录 `~/.openclaw/skills-cache/commit-helper`
120
- 2. 执行 `git pull`
121
- 3. 重新复制最新的技能目录
122
-
123
- ### 列出本地技能
124
-
125
- ```bash
126
- getskill list
127
- ```
128
-
129
- 返回 `~/.openclaw/skills` 下的技能目录名称列表。
130
-
131
- ### 查看目录路径
132
-
133
- ```bash
134
- getskill path
135
- ```
136
-
137
- ### 清理缓存
138
-
139
- ```bash
140
- getskill clean
141
- ```
142
-
143
- 清理所有 Git 仓库缓存(不影响 skills 目录中的文件)
144
-
145
- ### 配置 API 地址
146
-
147
- 查看当前 API 地址:
148
- ```bash
149
- getskill config get
150
- ```
151
-
152
- 设置自定义 API 地址:
153
- ```bash
154
- getskill config set https://your-custom-api.com
155
- ```
156
-
157
- 通过环境变量设置:
158
- ```bash
159
- GETSKILL_BASE_URL=https://your-custom-api.com getskill search keyword
160
- ```
161
-
162
- ## API 接口规范
163
-
164
- ### 搜索 API
165
-
166
- ```
167
- GET https://getskill.work/api/v1/repos/search?sort=updated&order=desc&q=<关键词>&page=1&limit=20
168
- ```
169
-
170
- 响应格式:
171
- ```json
172
- {
173
- "ok": true,
174
- "data": [
175
- {
176
- "id": 1,
177
- "full_name": "skills/commit-helper",
178
- "description": "帮助生成规范的 git commit 信息",
179
- "html_url": "https://getskill.work/skills/commit-helper",
180
- "clone_url": "https://getskill.work/skills/commit-helper.git"
181
- }
182
- ]
183
- }
184
- ```
185
-
186
- ## 编程接口
187
-
188
- ```javascript
189
- const getskill = require('@workskills/getskill');
190
-
191
- // 设置自定义 API 地址(可选)
192
- getskill.setBaseUrl('https://your-custom-api.com');
193
-
194
- // 搜索技能
195
- const results = await getskill.searchSkills('commit');
196
-
197
- // 安装技能
198
- const result = await getskill.downloadSkill('skills/commit-helper');
199
- console.log(result.files); // 已复制的技能目录列表
200
-
201
- // 更新技能
202
- await getskill.updateSkill('commit-helper');
203
-
204
- // 列出本地技能
205
- const skills = getskill.listLocalSkills();
206
-
207
- // 获取目录
208
- const skillsDir = getskill.getSkillsDirectory();
209
- const cacheDir = getskill.getSkillsCacheDirectory();
210
-
211
- // 获取当前 API 地址
212
- const baseUrl = getskill.getBaseUrl();
213
- ```
214
-
215
- ## 技能仓库规范
216
-
217
- 技能 Git 仓库应包含:
218
- - 一个或多个 `.md` 技能文件(非 README)
219
- - 可选的 `README.md` 说明文档
220
- - 可选的示例代码或配置文件
221
-
222
- 示例结构:
223
- ```
224
- commit-helper/
225
- ├── commit-helper.md # 技能文件(仓库目录会被整体复制)
226
- ├── README.md # 说明文档(会随目录复制)
227
- └── examples/ # 示例(会随目录复制)
228
- ```
229
-
230
- ## 依赖
231
-
232
- - Node.js >= 12
233
- - Git 命令行工具(如未安装,程序会自动引导安装)
234
-
235
- ## Git 自动检测与安装
236
-
237
- 首次运行 `install` 或 `update` 命令时,程序会自动检测系统是否已安装 Git:
238
-
239
- ### Windows
240
- - **自动下载**: 自动下载 Git 安装程序并启动安装向导
241
- - **手动安装**: 如果自动下载失败,会提示访问 https://git-scm.com/download/win
242
-
243
- ### macOS
244
- - 提示使用 Homebrew 安装:`brew install git`
245
- - 如未安装 Homebrew,会提示访问 https://brew.sh/
246
-
247
- ### Linux
248
- - 提示使用系统包管理器安装:
249
- - Ubuntu/Debian: `sudo apt-get install git`
250
- - CentOS/RHEL: `sudo yum install git`
251
- - Fedora: `sudo dnf install git`
252
- - Arch: `sudo pacman -S git`
253
-
254
- ## 许可证
255
-
256
- MIT
257
-
258
- ## 作者
259
-
260
- workskills.store
1
+ # GetSkill
2
+
3
+ OpenClaw 技能管理工具 - 从 getskill.work 搜索、下载和更新技能文件
4
+
5
+ ## 功能特性
6
+
7
+ - 🔍 从 getskill.work API 搜索技能
8
+ - 🧾 支持 JSON 格式搜索输出(`search --json`)
9
+ - 📥 通过 Git 克隆技能仓库
10
+ - 🏷️ 支持安装/更新指定版本(`--version <tag>`)
11
+ - 🔄 通过 Git pull 更新已安装的技能
12
+ - 🚀 支持将本地技能目录发布到 Git 远程仓库(`publish`)
13
+ - 🛠️ 自动检测并引导安装 Git(如未安装)
14
+ - 📂 跨平台支持(Windows/macOS/Linux)
15
+ - 💾 自动管理技能文件到 OpenClaw skills 目录
16
+ - ⚙️ 支持自定义 API 地址
17
+
18
+ ## 工作原理
19
+
20
+ 1. **搜索**: 从 `getskill.work` API 获取技能列表,包含 Git 仓库地址
21
+ 2. **安装**: 使用 `git clone` 克隆技能仓库到缓存目录
22
+ 3. **复制**: 将仓库目录(排除 `.git`)复制到 OpenClaw skills 目录
23
+ 4. **更新**: 使用 `git pull` 更新仓库,并重新复制技能目录
24
+
25
+ ## 目录结构
26
+
27
+ ```
28
+ ~/.openclaw/
29
+ ├── skills/ # OpenClaw 技能目录
30
+ │ ├── skill1/
31
+ │ └── skill2/
32
+ └── skills-cache/ # Git 仓库缓存
33
+ ├── skill1/
34
+ └── skill2/
35
+ ```
36
+
37
+ ### 平台路径
38
+
39
+ - **Windows**: `%USERPROFILE%\.openclaw\skills`
40
+ - **macOS**: `~/.openclaw/skills`
41
+ - **Linux**: `~/.openclaw/skills`
42
+
43
+ ## 安装
44
+
45
+ ### 全局安装(推荐)
46
+
47
+ ```bash
48
+ npm install -g @workskills/getskill
49
+ ```
50
+
51
+ 安装后,可以在任何位置使用 `getskill` 命令。
52
+
53
+ ### 本地安装
54
+
55
+ ```bash
56
+ npm install @workskills/getskill
57
+ ```
58
+
59
+ 本地安装后,可以通过 npx 运行:
60
+
61
+ ```bash
62
+ npx getskill search <关键词>
63
+ ```
64
+
65
+ ### 从源码安装
66
+
67
+ ```bash
68
+ git clone https://github.com/work-skills/getskill.git
69
+ cd getskill
70
+ npm install
71
+ npm link
72
+ ```
73
+
74
+ ## 使用方法
75
+
76
+ ### 搜索技能
77
+
78
+ > `search` / `install` / `update` / `list` / `inspect` / `clean` **默认都不需要登录**。只有 `publish` 才需要登录。
79
+
80
+ ```bash
81
+ getskill search <关键词>
82
+ ```
83
+
84
+ 输出 JSON:
85
+
86
+ ```bash
87
+ getskill search <关键词> --json
88
+ ```
89
+
90
+ 示例输出:
91
+
92
+ ```
93
+ 找到 3 个技能:
94
+
95
+ 1. commit-helper
96
+ 描述: 帮助生成规范的 git commit 信息
97
+ Git: https://getskill.work/skills/commit-helper.git
98
+
99
+ 2. code-review
100
+ 描述: AI 代码审查助手
101
+ Git: https://getskill.work/skills/code-review.git
102
+ ```
103
+
104
+ ### 安装技能
105
+
106
+ ```bash
107
+ getskill install <技能名称>
108
+ ```
109
+
110
+ 安装指定版本:
111
+
112
+ ```bash
113
+ getskill install <技能名称> --version <tag>
114
+ ```
115
+
116
+ 示例:
117
+
118
+ ```bash
119
+ getskill install commit-helper
120
+ ```
121
+
122
+ 操作流程:
123
+
124
+ 1. 执行 `git clone` 到 `~/.openclaw/skills-cache/commit-helper`
125
+ 2. 将整个技能目录复制到 `~/.openclaw/skills/commit-helper`
126
+
127
+ ### 更新技能
128
+
129
+ ```bash
130
+ getskill update <技能名称>
131
+ ```
132
+
133
+ 示例:
134
+
135
+ ```bash
136
+ getskill update commit-helper
137
+ ```
138
+
139
+ 批量更新所有已安装技能:
140
+
141
+ ```bash
142
+ getskill update --all
143
+ ```
144
+
145
+ 切换到指定版本:
146
+
147
+ ```bash
148
+ getskill update <技能名称> --version <tag>
149
+ ```
150
+
151
+ 操作流程:
152
+
153
+ 1. 进入缓存目录 `~/.openclaw/skills-cache/commit-helper`
154
+ 2. 执行 `git pull`
155
+ 3. 重新复制最新的技能目录
156
+
157
+ ### 卸载技能
158
+
159
+ ```bash
160
+ getskill uninstall <技能名称>
161
+ ```
162
+
163
+ 仅卸载本地技能目录、保留缓存:
164
+
165
+ ```bash
166
+ getskill uninstall commit-helper --keep-cache
167
+ ```
168
+
169
+ ### 查看安装状态
170
+
171
+ ```bash
172
+ getskill inspect <技能名称>
173
+ ```
174
+
175
+ ### 发布技能目录
176
+
177
+ ```bash
178
+ getskill publish <目录>
179
+ ```
180
+
181
+ 默认行为:
182
+
183
+ 1. 检查目录中是否存在 `SKILL.md`
184
+ 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
+ ```
195
+
196
+ 可选参数:
197
+
198
+ - `--branch <name>`: 发布分支(默认 `main`)
199
+ - `--message <text>`: 自定义提交信息
200
+ - `--name <repo-name>`: 指定自动创建的仓库名称
201
+ - `--username <name>` / `--email <mail>` / `--password <pwd>`: 非交互发布时提供注册/登录信息
202
+ - `--private`: 创建私有仓库
203
+
204
+ > 如果 `SKILL.md` 缺失,或不符合规范(缺少 front matter、`metadata`、`## 指令` 等关键结构),发布会被直接阻止。
205
+
206
+ ### 列出本地技能
207
+
208
+ ```bash
209
+ getskill list
210
+ ```
211
+
212
+ 返回 `~/.openclaw/skills` 下的技能目录名称列表。
213
+
214
+ ### 查看目录路径
215
+
216
+ ```bash
217
+ getskill path
218
+ ```
219
+
220
+ ### 清理缓存
221
+
222
+ ```bash
223
+ getskill clean
224
+ ```
225
+
226
+ 清理所有 Git 仓库缓存(不影响 skills 目录中的文件)
227
+
228
+ ### 配置 API 地址
229
+
230
+ 查看当前 API 地址:
231
+
232
+ ```bash
233
+ getskill config get
234
+ ```
235
+
236
+ 设置自定义 API 地址:
237
+
238
+ ```bash
239
+ getskill config set https://your-custom-api.com
240
+ ```
241
+
242
+ 通过环境变量设置:
243
+
244
+ ```bash
245
+ GETSKILL_BASE_URL=https://your-custom-api.com getskill search keyword
246
+ ```
247
+
248
+ ## API 接口规范
249
+
250
+ ### 搜索 API
251
+
252
+ ```
253
+ GET https://getskill.work/api/v1/repos/search?sort=updated&order=desc&q=<关键词>&page=1&limit=20
254
+ ```
255
+
256
+ 响应格式:
257
+
258
+ ```json
259
+ {
260
+ "ok": true,
261
+ "data": [
262
+ {
263
+ "id": 1,
264
+ "full_name": "skills/commit-helper",
265
+ "description": "帮助生成规范的 git commit 信息",
266
+ "html_url": "https://getskill.work/skills/commit-helper",
267
+ "clone_url": "https://getskill.work/skills/commit-helper.git"
268
+ }
269
+ ]
270
+ }
271
+ ```
272
+
273
+ ## 编程接口
274
+
275
+ ```javascript
276
+ const getskill = require('@workskills/getskill');
277
+
278
+ // 设置自定义 API 地址(可选)
279
+ getskill.setBaseUrl('https://your-custom-api.com');
280
+
281
+ // 搜索技能
282
+ const results = await getskill.searchSkills('commit');
283
+
284
+ // 安装技能
285
+ const result = await getskill.downloadSkill('skills/commit-helper');
286
+ console.log(result.files); // 已复制的技能目录列表
287
+
288
+ // 更新技能
289
+ await getskill.updateSkill('commit-helper');
290
+
291
+ // 列出本地技能
292
+ const skills = getskill.listLocalSkills();
293
+
294
+ // 获取目录
295
+ const skillsDir = getskill.getSkillsDirectory();
296
+ const cacheDir = getskill.getSkillsCacheDirectory();
297
+
298
+ // 获取当前 API 地址
299
+ const baseUrl = getskill.getBaseUrl();
300
+ ```
301
+
302
+ ## 技能仓库规范
303
+
304
+ 技能 Git 仓库应包含:
305
+
306
+ - 一个或多个 `.md` 技能文件(非 README)
307
+ - 可选的 `README.md` 说明文档
308
+ - 可选的示例代码或配置文件
309
+
310
+ 示例结构:
311
+
312
+ ```
313
+ commit-helper/
314
+ ├── commit-helper.md # 技能文件(仓库目录会被整体复制)
315
+ ├── README.md # 说明文档(会随目录复制)
316
+ └── examples/ # 示例(会随目录复制)
317
+ ```
318
+
319
+ ## 依赖
320
+
321
+ - Node.js >= 12(运行 CLI)
322
+ - Node.js 18+(开发与测试工具)
323
+ - Git 命令行工具(如未安装,程序会自动引导安装)
324
+
325
+ ## 开发与质量保障
326
+
327
+ ```bash
328
+ npm install
329
+ npm run build
330
+ npm run lint
331
+ npm test
332
+ npm run test:flow
333
+ npm run coverage
334
+ ```
335
+
336
+ 当前源码已迁移为 **TypeScript**,发布产物位于 `dist/`。
337
+
338
+ 开发文档:
339
+
340
+ - [`CONTRIBUTING.md`](CONTRIBUTING.md)
341
+ - [`docs/architecture.md`](docs/architecture.md)
342
+
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
+ ## 许可证
366
+
367
+ MIT
368
+
369
+ ## 作者
370
+
371
+ workskills.store
@@ -0,0 +1,10 @@
1
+ export declare const REQUEST_TIMEOUT_MS = 60000;
2
+ export declare const MAX_COPY_FILE_SIZE_BYTES: number;
3
+ export declare function setBaseUrl(url: string): string;
4
+ export declare function getBaseUrl(): string;
5
+ export declare function getOpenClawRootDirectory(): string;
6
+ export declare function getSkillsDirectory(): string;
7
+ export declare function getSkillsCacheDirectory(): string;
8
+ export declare function getGetSkillConfigDirectory(): string;
9
+ export declare function getStateFilePath(): string;
10
+ export declare function getAuthFilePath(): string;