@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/README.md
CHANGED
|
@@ -1,106 +1,111 @@
|
|
|
1
1
|
# GetSkill
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
AI Agent 技能管理工具 - 从 getskill.work 搜索、下载和更新技能文件,适用于任意 Agent(Claude Code、OpenClaw、Codex、Cursor……或任意自定义技能目录)。
|
|
4
4
|
|
|
5
5
|
## 功能特性
|
|
6
6
|
|
|
7
|
-
- 🔍 从 `getskill.work` 静态技能索引(`data/skills.json
|
|
8
|
-
-
|
|
9
|
-
-
|
|
10
|
-
- 🏷️
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
- ⚙️ 支持自定义索引地址
|
|
7
|
+
- 🔍 从 `getskill.work` 静态技能索引(`data/skills.json`)搜索技能,支持 `--json` 输出
|
|
8
|
+
- 📥 通过 HTTPS 直接下载技能 ZIP 包并在本地解压安装(**无需 Git、无需登录**)
|
|
9
|
+
- 🔄 基于版本号比较的增量更新(`update` / `update --all`,`--prune` 可清理已下架技能的历史记录)
|
|
10
|
+
- 🏷️ 安装/更新时可用 `--version <version>` 校验版本(站点仅提供最新版本,传入其它版本号会报错并提示当前版本)
|
|
11
|
+
- 🤖 **不绑定任何 Agent**:内置多种 Agent 目录预设,可自动识别本机 Agent,也可指定任意自定义技能目录
|
|
12
|
+
- 💾 配置持久化到 `~/.getskill/config.json`,安装记录持久化到 `~/.getskill/state.json`(自动迁移旧版 `~/.openclaw/getskill/state.json`)
|
|
13
|
+
- ⚙️ 支持环境变量与命令行参数覆盖(`GETSKILL_BASE_URL`、`GETSKILL_AGENT`、`GETSKILL_SKILLS_DIR` 等)
|
|
14
|
+
- 📂 跨平台支持(Windows / macOS / Linux)
|
|
16
15
|
- 📦 零第三方运行时依赖(内置 ZIP 解析/解压实现)
|
|
17
16
|
|
|
18
|
-
##
|
|
19
|
-
|
|
20
|
-
1. **搜索**: 拉取 `https://getskill.work/data/skills.json` 静态索引,本地按关键词过滤
|
|
21
|
-
2. **安装**: 下载 `https://getskill.work/skills/<id>.zip` 到缓存目录并本地解压
|
|
22
|
-
3. **复制**: 将解压后的技能目录复制到 OpenClaw skills 目录,并记录版本信息
|
|
23
|
-
4. **更新**: 比较本地已安装版本与远端索引版本,不一致时重新下载解压
|
|
17
|
+
## 安装
|
|
24
18
|
|
|
25
|
-
|
|
19
|
+
全局安装后即可在任意位置使用 `getskill` 命令:
|
|
26
20
|
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
├── skills/ # OpenClaw 技能目录
|
|
30
|
-
│ ├── skill1/
|
|
31
|
-
│ └── skill2/
|
|
32
|
-
└── skills-cache/ # ZIP 下载与解压缓存
|
|
33
|
-
├── skill1/
|
|
34
|
-
└── skill2/
|
|
21
|
+
```bash
|
|
22
|
+
npm install -g @workskills/getskill
|
|
35
23
|
```
|
|
36
24
|
|
|
37
|
-
|
|
25
|
+
也可以不安装直接通过 npx 运行:
|
|
38
26
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
27
|
+
```bash
|
|
28
|
+
npx @workskills/getskill search <关键词>
|
|
29
|
+
```
|
|
42
30
|
|
|
43
|
-
|
|
31
|
+
要求 Node.js >= 18。
|
|
44
32
|
|
|
45
|
-
|
|
33
|
+
## 目标 Agent 与技能目录
|
|
34
|
+
|
|
35
|
+
`getskill` 把技能安装到「当前 Agent 的技能目录」。查看当前生效的 Agent 与目录:
|
|
46
36
|
|
|
47
37
|
```bash
|
|
48
|
-
|
|
38
|
+
getskill path
|
|
49
39
|
```
|
|
50
40
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### 本地安装
|
|
41
|
+
列出内置 Agent 预设(`*` 表示当前生效):
|
|
54
42
|
|
|
55
43
|
```bash
|
|
56
|
-
|
|
44
|
+
getskill agents
|
|
57
45
|
```
|
|
58
46
|
|
|
59
|
-
|
|
47
|
+
内置预设:
|
|
48
|
+
|
|
49
|
+
| agent | Agent | 技能目录 |
|
|
50
|
+
| ---------- | ------------------ | --------------------------- |
|
|
51
|
+
| `claude` | Claude Code | `~/.claude/skills` |
|
|
52
|
+
| `openclaw` | OpenClaw | `~/.openclaw/skills` |
|
|
53
|
+
| `codex` | OpenAI Codex CLI | `~/.codex/skills` |
|
|
54
|
+
| `cursor` | Cursor | `~/.cursor/skills` |
|
|
55
|
+
| `gemini` | Gemini CLI | `~/.gemini/skills` |
|
|
56
|
+
| `qwen` | Qwen Code | `~/.qwen/skills` |
|
|
57
|
+
| `copilot` | GitHub Copilot CLI | `~/.copilot/skills` |
|
|
58
|
+
| `amp` | Amp | `~/.config/amp/skills` |
|
|
59
|
+
| `opencode` | OpenCode | `~/.config/opencode/skills` |
|
|
60
|
+
| `agent` | 通用 Agent 目录 | `~/.agent/skills` |
|
|
61
|
+
|
|
62
|
+
默认 `agent = auto`:按「历史安装记录 → 已存在且非空的技能目录 → 已存在的 Agent 根目录」顺序自动识别;都识别不到时使用 `~/.claude/skills`。
|
|
63
|
+
|
|
64
|
+
不在预设列表中的 Agent,直接指定技能目录即可(三种方式任选一种):
|
|
60
65
|
|
|
61
66
|
```bash
|
|
62
|
-
|
|
67
|
+
# 1) 持久化保存
|
|
68
|
+
getskill config set skills-dir ~/.my-agent/skills
|
|
69
|
+
|
|
70
|
+
# 2) 仅本次命令生效
|
|
71
|
+
getskill --skills-dir ~/.my-agent/skills install <技能名称>
|
|
72
|
+
|
|
73
|
+
# 3) 环境变量
|
|
74
|
+
GETSKILL_SKILLS_DIR=~/.my-agent/skills getskill install <技能名称>
|
|
63
75
|
```
|
|
64
76
|
|
|
65
|
-
|
|
77
|
+
指定 Agent(持久化 / 单次):
|
|
66
78
|
|
|
67
79
|
```bash
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
npm install
|
|
71
|
-
npm link
|
|
80
|
+
getskill config set agent cursor
|
|
81
|
+
getskill --agent codex install <技能名称>
|
|
72
82
|
```
|
|
73
83
|
|
|
84
|
+
下载与解压缓存默认位于 `~/.getskill/cache`,可用 `cache-dir` 配置或 `GETSKILL_CACHE_DIR` 覆盖。
|
|
85
|
+
|
|
74
86
|
## 使用方法
|
|
75
87
|
|
|
76
88
|
### 搜索技能
|
|
77
89
|
|
|
78
|
-
> `search` / `install` / `update` / `list` / `inspect` / `clean` **全部无需登录、无需 Git**。只有 `publish` 需要用户提供自己的 Git 远程仓库。
|
|
79
|
-
|
|
80
90
|
```bash
|
|
81
91
|
getskill search <关键词>
|
|
82
92
|
```
|
|
83
93
|
|
|
84
|
-
|
|
94
|
+
JSON 格式输出:
|
|
85
95
|
|
|
86
96
|
```bash
|
|
87
97
|
getskill search <关键词> --json
|
|
88
98
|
```
|
|
89
99
|
|
|
90
|
-
|
|
100
|
+
示例(`getskill search pdf-toolkit`):
|
|
91
101
|
|
|
92
102
|
```
|
|
93
|
-
找到
|
|
103
|
+
找到 1 个技能:
|
|
94
104
|
|
|
95
|
-
1. pdf-
|
|
96
|
-
描述:
|
|
105
|
+
1. pdf-toolkit (v1.0.0)
|
|
106
|
+
描述: PDF 文档处理技能:提取文本、合并拆分、页面旋转与加水印。当用户需要处理 PDF 文件时使用。
|
|
97
107
|
分类: 文档处理
|
|
98
|
-
下载: https://getskill.work/skills/pdf-
|
|
99
|
-
|
|
100
|
-
2. xlsx (v1.0.0)
|
|
101
|
-
描述: 电子表格文件的创建、编辑与分析
|
|
102
|
-
分类: 文档处理
|
|
103
|
-
下载: https://getskill.work/skills/xlsx.zip
|
|
108
|
+
下载: https://getskill.work/skills/pdf-toolkit.zip
|
|
104
109
|
```
|
|
105
110
|
|
|
106
111
|
### 安装技能
|
|
@@ -109,23 +114,33 @@ getskill search <关键词> --json
|
|
|
109
114
|
getskill install <技能名称>
|
|
110
115
|
```
|
|
111
116
|
|
|
112
|
-
|
|
117
|
+
示例:
|
|
113
118
|
|
|
114
119
|
```bash
|
|
115
|
-
getskill install
|
|
120
|
+
getskill install pdf-toolkit
|
|
116
121
|
```
|
|
117
122
|
|
|
118
|
-
|
|
123
|
+
输出:
|
|
119
124
|
|
|
120
|
-
```
|
|
121
|
-
|
|
125
|
+
```
|
|
126
|
+
下载技能: pdf-toolkit...
|
|
127
|
+
下载技能包: https://getskill.work/skills/pdf-toolkit.zip
|
|
128
|
+
下载完成 (1025 bytes),正在解压...
|
|
129
|
+
技能 pdf-toolkit (v1.0.0) 安装成功!
|
|
130
|
+
|
|
131
|
+
目标 Agent: claude (Claude Code)
|
|
132
|
+
技能已安装到 skills 目录:
|
|
133
|
+
- C:\Users\<用户名>\.claude\skills\pdf-toolkit
|
|
134
|
+
|
|
135
|
+
本地缓存: C:\Users\<用户名>\.getskill\cache\pdf-toolkit\pdf-toolkit
|
|
136
|
+
已安装版本: 1.0.0
|
|
122
137
|
```
|
|
123
138
|
|
|
124
139
|
操作流程:
|
|
125
140
|
|
|
126
|
-
1.
|
|
127
|
-
2. 下载 ZIP
|
|
128
|
-
3.
|
|
141
|
+
1. 在静态索引中定位技能条目,获取下载地址
|
|
142
|
+
2. 下载 ZIP 包到缓存目录(默认 `~/.getskill/cache/<技能名称>`)并解压
|
|
143
|
+
3. 将技能目录复制到当前 Agent 的技能目录,并记录已安装版本
|
|
129
144
|
|
|
130
145
|
### 更新技能
|
|
131
146
|
|
|
@@ -139,17 +154,18 @@ getskill update <技能名称>
|
|
|
139
154
|
getskill update --all
|
|
140
155
|
```
|
|
141
156
|
|
|
142
|
-
|
|
157
|
+
批量更新并清理索引中已下架技能的历史记录:
|
|
143
158
|
|
|
144
159
|
```bash
|
|
145
|
-
getskill update
|
|
160
|
+
getskill update --all --prune
|
|
146
161
|
```
|
|
147
162
|
|
|
148
163
|
更新逻辑:
|
|
149
164
|
|
|
150
|
-
1.
|
|
165
|
+
1. 读取本地已安装技能的版本记录(仅统计属于当前技能目录的记录)
|
|
151
166
|
2. 拉取远端索引中的最新版本号
|
|
152
|
-
3.
|
|
167
|
+
3. 版本一致时提示“已是最新版本”;不一致时重新下载 ZIP 并覆盖安装
|
|
168
|
+
4. 索引中已不存在的技能会被标记为“已跳过”,不算失败;加 `--prune` 可清理这些失效记录
|
|
153
169
|
|
|
154
170
|
### 卸载技能
|
|
155
171
|
|
|
@@ -169,28 +185,21 @@ getskill uninstall <技能名称> --keep-cache
|
|
|
169
185
|
getskill inspect <技能名称>
|
|
170
186
|
```
|
|
171
187
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
`publish` 将本地技能目录提交并推送到**你自己的 Git 远程仓库**(如 GitHub):
|
|
188
|
+
输出示例:
|
|
175
189
|
|
|
176
|
-
```bash
|
|
177
|
-
getskill publish <目录> --repo <git-url>
|
|
178
190
|
```
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
> 如果 `SKILL.md` 缺失,或不符合规范(缺少 front matter、`metadata`、`## 指令` 等关键结构),发布会被直接阻止。
|
|
193
|
-
> 官方索引(getskill.work)当前不接受自助发布,收录请联系站点维护者。
|
|
191
|
+
技能名称: pdf-toolkit
|
|
192
|
+
本地目录: pdf-toolkit
|
|
193
|
+
目标 Agent: claude (Claude Code)
|
|
194
|
+
已安装: 是
|
|
195
|
+
已缓存: 是
|
|
196
|
+
技能路径: C:\Users\<用户名>\.claude\skills\pdf-toolkit
|
|
197
|
+
技能目录: C:\Users\<用户名>\.claude\skills
|
|
198
|
+
缓存目录: C:\Users\<用户名>\.getskill\cache\pdf-toolkit
|
|
199
|
+
解压路径: C:\Users\<用户名>\.getskill\cache\pdf-toolkit\pdf-toolkit
|
|
200
|
+
最后动作: install
|
|
201
|
+
版本: 1.0.0
|
|
202
|
+
```
|
|
194
203
|
|
|
195
204
|
### 列出本地技能
|
|
196
205
|
|
|
@@ -198,12 +207,19 @@ getskill publish <目录> --repo <git-url>
|
|
|
198
207
|
getskill list
|
|
199
208
|
```
|
|
200
209
|
|
|
201
|
-
|
|
210
|
+
返回当前 Agent 技能目录下的技能目录名称列表:
|
|
202
211
|
|
|
203
|
-
|
|
212
|
+
```
|
|
213
|
+
本地已安装的技能 (1) · Agent: claude · 目录: C:\Users\<用户名>\.claude\skills
|
|
214
|
+
1. pdf-toolkit
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
### 查看路径与配置
|
|
204
218
|
|
|
205
219
|
```bash
|
|
206
|
-
getskill path
|
|
220
|
+
getskill path # Agent、技能目录、缓存目录、配置文件、状态文件、站点地址
|
|
221
|
+
getskill agents # 内置 Agent 预设与当前生效项
|
|
222
|
+
getskill config get
|
|
207
223
|
```
|
|
208
224
|
|
|
209
225
|
### 清理缓存
|
|
@@ -212,142 +228,93 @@ getskill path
|
|
|
212
228
|
getskill clean
|
|
213
229
|
```
|
|
214
230
|
|
|
215
|
-
清理 ZIP
|
|
231
|
+
清理 ZIP 下载与解压缓存(不影响技能目录中的文件),同时清理旧版本遗留的 `~/.openclaw/skills-cache`。
|
|
216
232
|
|
|
217
|
-
###
|
|
218
|
-
|
|
219
|
-
查看当前索引地址:
|
|
233
|
+
### 帮助与版本
|
|
220
234
|
|
|
221
235
|
```bash
|
|
222
|
-
getskill
|
|
236
|
+
getskill --help
|
|
237
|
+
getskill --version
|
|
223
238
|
```
|
|
224
239
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
```bash
|
|
228
|
-
getskill config set https://your-custom-index.com
|
|
229
|
-
```
|
|
240
|
+
## 配置
|
|
230
241
|
|
|
231
|
-
|
|
242
|
+
配置项保存在 `~/.getskill/config.json`(可用 `GETSKILL_HOME` 改变该目录位置)。
|
|
232
243
|
|
|
233
244
|
```bash
|
|
234
|
-
|
|
245
|
+
getskill config get # 查看全部配置项及其来源
|
|
246
|
+
getskill config get <key> # 查看单个配置项
|
|
247
|
+
getskill config set <key> <value> # 保存配置项
|
|
248
|
+
getskill config unset <key> # 删除配置项,恢复自动识别/默认值
|
|
249
|
+
getskill config path # 显示配置文件路径
|
|
250
|
+
getskill config agents # 列出支持的 Agent
|
|
235
251
|
```
|
|
236
252
|
|
|
237
|
-
|
|
253
|
+
可用配置项:
|
|
238
254
|
|
|
239
|
-
|
|
255
|
+
| key | 说明 | 示例 |
|
|
256
|
+
| ------------ | ------------------------------------ | ----------------------------------------------------- |
|
|
257
|
+
| `base-url` | 技能索引站点地址 | `getskill config set base-url https://your-index.com` |
|
|
258
|
+
| `agent` | 目标 Agent(预设名或 `auto`) | `getskill config set agent cursor` |
|
|
259
|
+
| `skills-dir` | 任意自定义技能目录(优先于 `agent`) | `getskill config set skills-dir ~/.my-agent/skills` |
|
|
260
|
+
| `cache-dir` | 下载/解压缓存目录 | `getskill config set cache-dir ~/.cache/getskill` |
|
|
240
261
|
|
|
241
|
-
|
|
242
|
-
GET https://getskill.work/data/skills.json
|
|
243
|
-
```
|
|
262
|
+
兼容旧写法:`getskill config set <URL>` 等价于 `getskill config set base-url <URL>`。
|
|
244
263
|
|
|
245
|
-
|
|
264
|
+
`config get` 输出示例:
|
|
246
265
|
|
|
247
|
-
```json
|
|
248
|
-
{
|
|
249
|
-
"updated": "2026-11-20",
|
|
250
|
-
"skills": [
|
|
251
|
-
{
|
|
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"
|
|
263
|
-
}
|
|
264
|
-
]
|
|
265
|
-
}
|
|
266
266
|
```
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
267
|
+
base-url: https://getskill.work
|
|
268
|
+
来源: 默认值,未保存,使用默认站点
|
|
269
|
+
agent: claude (Claude Code)
|
|
270
|
+
来源: 配置文件,已保存: claude
|
|
271
|
+
skills-dir: C:\Users\<用户名>\.claude\skills
|
|
272
|
+
来源: 配置文件,未单独保存,由 agent 推导
|
|
273
|
+
cache-dir: C:\Users\<用户名>\.getskill\cache
|
|
274
|
+
来源: 默认值,未保存,使用默认缓存目录
|
|
275
|
+
配置文件: C:\Users\<用户名>\.getskill\config.json
|
|
276
|
+
状态文件: C:\Users\<用户名>\.getskill\state.json
|
|
270
277
|
```
|
|
271
|
-
GET https://getskill.work/skills/<id>.zip
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
ZIP 包根目录(或唯一包装目录)下应包含 `SKILL.md` 及配套文件。
|
|
275
|
-
|
|
276
|
-
## 编程接口
|
|
277
|
-
|
|
278
|
-
```javascript
|
|
279
|
-
const getskill = require('@workskills/getskill');
|
|
280
278
|
|
|
281
|
-
|
|
282
|
-
getskill.setBaseUrl('https://your-custom-index.com');
|
|
279
|
+
### 环境变量
|
|
283
280
|
|
|
284
|
-
|
|
285
|
-
|
|
281
|
+
| 变量 | 作用 |
|
|
282
|
+
| ---------------------- | ------------------------------------------------ |
|
|
283
|
+
| `GETSKILL_BASE_URL` | 覆盖索引站点地址 |
|
|
284
|
+
| `GETSKILL_AGENT` | 覆盖目标 Agent(预设名或 `auto`) |
|
|
285
|
+
| `GETSKILL_SKILLS_DIR` | 覆盖技能目录(任意 Agent) |
|
|
286
|
+
| `GETSKILL_CACHE_DIR` | 覆盖缓存目录 |
|
|
287
|
+
| `GETSKILL_HOME` | 覆盖 `~/.getskill`(配置/状态/缓存的根目录) |
|
|
288
|
+
| `GETSKILL_STATE_FILE` | 覆盖安装记录文件路径 |
|
|
289
|
+
| `GETSKILL_RESTART_CMD` | 安装/更新后执行的重载命令(任意 Agent 均可用) |
|
|
290
|
+
| `GETSKILL_LOG_LEVEL` | 日志级别:`silent`/`error`/`warn`/`info`/`debug` |
|
|
286
291
|
|
|
287
|
-
|
|
288
|
-
const result = await getskill.downloadSkill('pdf-extract');
|
|
289
|
-
console.log(result.files); // 已复制的技能目录列表
|
|
292
|
+
Bash / zsh:
|
|
290
293
|
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
// 列出本地技能
|
|
295
|
-
const skills = getskill.listLocalSkills();
|
|
296
|
-
|
|
297
|
-
// 获取目录
|
|
298
|
-
const skillsDir = getskill.getSkillsDirectory();
|
|
299
|
-
const cacheDir = getskill.getSkillsCacheDirectory();
|
|
300
|
-
|
|
301
|
-
// 获取当前索引地址
|
|
302
|
-
const baseUrl = getskill.getBaseUrl();
|
|
294
|
+
```bash
|
|
295
|
+
GETSKILL_SKILLS_DIR=~/.my-agent/skills getskill install pdf-toolkit
|
|
303
296
|
```
|
|
304
297
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
技能 ZIP 包应包含:
|
|
308
|
-
|
|
309
|
-
- `SKILL.md` 技能定义文件(含 front matter 与指令内容)
|
|
310
|
-
- 可选的 `README.md` 说明文档
|
|
311
|
-
- 可选的示例代码、脚本或配置文件
|
|
312
|
-
|
|
313
|
-
示例结构:
|
|
298
|
+
Windows PowerShell:
|
|
314
299
|
|
|
315
|
-
```
|
|
316
|
-
pdf-
|
|
317
|
-
├── SKILL.md # 技能定义文件(必需)
|
|
318
|
-
├── README.md # 说明文档(可选,会随目录复制)
|
|
319
|
-
├── scripts/ # 脚本(可选,会随目录复制)
|
|
320
|
-
└── examples/ # 示例(可选,会随目录复制)
|
|
300
|
+
```powershell
|
|
301
|
+
$env:GETSKILL_SKILLS_DIR = "$HOME\.my-agent\skills"; getskill install pdf-toolkit
|
|
321
302
|
```
|
|
322
303
|
|
|
323
|
-
|
|
304
|
+
### 优先级
|
|
324
305
|
|
|
325
|
-
-
|
|
326
|
-
- Node.js 18+(开发与测试工具)
|
|
327
|
-
- Git 命令行工具(仅 `publish` 命令需要;搜索/安装/更新均不依赖 Git)
|
|
306
|
+
命令行参数(`--agent` / `--skills-dir` / `--cache-dir` / `--base-url`) > 环境变量 > 配置文件 > 自动识别 / 默认值。
|
|
328
307
|
|
|
329
|
-
##
|
|
308
|
+
## 目录结构
|
|
330
309
|
|
|
331
|
-
```bash
|
|
332
|
-
npm install
|
|
333
|
-
npm run build
|
|
334
|
-
npm run lint
|
|
335
|
-
npm test
|
|
336
|
-
npm run test:flow
|
|
337
|
-
npm run coverage
|
|
338
310
|
```
|
|
311
|
+
~/.getskill/
|
|
312
|
+
├── config.json # 持久化配置
|
|
313
|
+
├── state.json # 安装记录(技能名、版本、安装目录)
|
|
314
|
+
└── cache/
|
|
315
|
+
└── pdf-toolkit/ # ZIP 解压后的技能包内容
|
|
339
316
|
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
- [`CONTRIBUTING.md`](CONTRIBUTING.md)
|
|
345
|
-
- [`docs/architecture.md`](docs/architecture.md)
|
|
346
|
-
|
|
347
|
-
## 许可证
|
|
348
|
-
|
|
349
|
-
MIT
|
|
350
|
-
|
|
351
|
-
## 作者
|
|
352
|
-
|
|
353
|
-
getskill.work
|
|
317
|
+
~/.claude/skills/ # 当前 Agent 的技能目录(随 agent/skills-dir 配置变化)
|
|
318
|
+
└── pdf-toolkit/
|
|
319
|
+
└── SKILL.md
|
|
320
|
+
```
|
package/dist/lib/config.d.ts
CHANGED
|
@@ -1,9 +1,86 @@
|
|
|
1
|
+
export declare const DEFAULT_BASE_URL = "https://getskill.work";
|
|
1
2
|
export declare const REQUEST_TIMEOUT_MS = 60000;
|
|
2
3
|
export declare const MAX_COPY_FILE_SIZE_BYTES: number;
|
|
3
|
-
export declare
|
|
4
|
+
export declare const AUTO_AGENT_NAME = "auto";
|
|
5
|
+
export declare const CUSTOM_AGENT_NAME = "custom";
|
|
6
|
+
export declare const DEFAULT_AGENT_NAME = "claude";
|
|
7
|
+
export interface AgentPreset {
|
|
8
|
+
name: string;
|
|
9
|
+
label: string;
|
|
10
|
+
skillsPathSegments: string[];
|
|
11
|
+
restartCommand?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* 支持的 Agent 目录约定。任何 Agent 都可以通过 agent 预设、
|
|
15
|
+
* skillsDir 自定义目录或 GETSKILL_SKILLS_DIR 环境变量接入。
|
|
16
|
+
*/
|
|
17
|
+
export declare const AGENT_PRESETS: AgentPreset[];
|
|
18
|
+
export type ConfigKey = 'baseUrl' | 'agent' | 'skillsDir' | 'cacheDir';
|
|
19
|
+
export type ConfigSource = 'cli' | 'env' | 'file' | 'detect' | 'default';
|
|
20
|
+
export interface PersistedConfig {
|
|
21
|
+
baseUrl?: string;
|
|
22
|
+
agent?: string;
|
|
23
|
+
skillsDir?: string;
|
|
24
|
+
cacheDir?: string;
|
|
25
|
+
}
|
|
26
|
+
export interface ResolvedConfig {
|
|
27
|
+
baseUrl: string;
|
|
28
|
+
agent: string;
|
|
29
|
+
agentLabel: string;
|
|
30
|
+
skillsDir: string;
|
|
31
|
+
cacheDir: string;
|
|
32
|
+
homeDir: string;
|
|
33
|
+
configFile: string;
|
|
34
|
+
stateFile: string;
|
|
35
|
+
restartCommand: string | null;
|
|
36
|
+
sources: Record<ConfigKey, ConfigSource>;
|
|
37
|
+
}
|
|
38
|
+
export interface AgentSummary {
|
|
39
|
+
name: string;
|
|
40
|
+
label: string;
|
|
41
|
+
skillsDir: string;
|
|
42
|
+
exists: boolean;
|
|
43
|
+
active: boolean;
|
|
44
|
+
restartCommand: string | null;
|
|
45
|
+
}
|
|
46
|
+
export declare function normalizePath(value: string): string;
|
|
47
|
+
export declare function isSamePath(left: string, right: string): boolean;
|
|
48
|
+
export declare function normalizeBaseUrl(url: string): string;
|
|
49
|
+
export declare function normalizeConfigKey(key: string): ConfigKey;
|
|
50
|
+
export declare function getHomeDirectory(): string;
|
|
51
|
+
export declare function getGetSkillHome(): string;
|
|
52
|
+
export declare function getConfigFilePath(): string;
|
|
53
|
+
export declare function getStateFilePath(): string;
|
|
54
|
+
export declare function getLegacyStateFilePaths(): string[];
|
|
55
|
+
export declare function readConfigFile(): PersistedConfig;
|
|
56
|
+
export declare function writeConfigFile(config: PersistedConfig): void;
|
|
57
|
+
export declare function getAgentPreset(name?: string | null): AgentPreset | null;
|
|
58
|
+
export declare function getPresetSkillsDir(preset: AgentPreset): string;
|
|
59
|
+
/**
|
|
60
|
+
* 自动识别当前机器上正在使用的 Agent 技能目录。
|
|
61
|
+
* 优先级:历史安装记录 > 已存在且非空的技能目录 > 已存在的 Agent 根目录 > 默认值。
|
|
62
|
+
*/
|
|
63
|
+
export declare function detectAgentName(): string;
|
|
64
|
+
export declare function refreshConfig(): void;
|
|
65
|
+
/** 仅作用于当前进程的临时覆盖(例如 CLI 的 --agent / --skills-dir 参数)。 */
|
|
66
|
+
export declare function applyRuntimeOverrides(overrides: PersistedConfig): void;
|
|
67
|
+
export declare function clearRuntimeOverrides(): void;
|
|
68
|
+
export declare function resolveConfig(): ResolvedConfig;
|
|
69
|
+
export declare function getConfigSummary(): ResolvedConfig;
|
|
4
70
|
export declare function getBaseUrl(): string;
|
|
5
|
-
export declare function getOpenClawRootDirectory(): string;
|
|
6
71
|
export declare function getSkillsDirectory(): string;
|
|
7
72
|
export declare function getSkillsCacheDirectory(): string;
|
|
8
|
-
export declare function
|
|
9
|
-
export declare function
|
|
73
|
+
export declare function getAgentName(): string;
|
|
74
|
+
export declare function getAgentLabel(): string;
|
|
75
|
+
export declare function getAgentRestartCommand(): string | null;
|
|
76
|
+
export declare function listAgents(): AgentSummary[];
|
|
77
|
+
/** 历史版本(2.0 及更早)遗留的缓存目录,`clean` 命令会一并清理。 */
|
|
78
|
+
export declare function getLegacyCacheDirectories(): string[];
|
|
79
|
+
/** 写入并持久化配置项,返回写入后的完整生效配置。 */
|
|
80
|
+
export declare function setConfigValue(key: ConfigKey | string, rawValue: string): ResolvedConfig;
|
|
81
|
+
/** 删除已持久化的配置项,恢复为环境变量 / 自动识别 / 默认值。 */
|
|
82
|
+
export declare function unsetConfigValue(key: ConfigKey | string): ResolvedConfig;
|
|
83
|
+
export declare function setBaseUrl(url: string): string;
|
|
84
|
+
export declare function setAgent(name: string): string;
|
|
85
|
+
export declare function setSkillsDir(dir: string): string;
|
|
86
|
+
export declare function setCacheDir(dir: string): string;
|