left-skills 0.1.9 → 0.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/README.md +41 -32
- package/README.zh.md +104 -0
- package/dist/cli.js +27 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,89 +2,98 @@
|
|
|
2
2
|
|
|
3
3
|
# left-skills
|
|
4
4
|
|
|
5
|
-
**shift-left for skills** —
|
|
5
|
+
**shift-left for skills** — measure how your AI skills are used before users hit bugs.
|
|
6
6
|
|
|
7
7
|
[](https://www.npmjs.com/package/left-skills)
|
|
8
8
|
[](./LICENSE)
|
|
9
9
|
[](https://github.com/cuikexi/left-skills)
|
|
10
10
|
|
|
11
|
+
[中文](./README.zh.md)
|
|
12
|
+
|
|
11
13
|
</div>
|
|
12
14
|
|
|
13
|
-
##
|
|
15
|
+
## Why "left-skills"?
|
|
14
16
|
|
|
15
|
-
`left-skills` = **shift-left for skills
|
|
17
|
+
`left-skills` = **shift-left for skills**. Move quality/measurement "left" — to *before* a skill is put into use — instead of waiting for users to hit bugs. Know which skills never get called, fix them early.
|
|
16
18
|
|
|
17
19
|
## How It Works
|
|
18
20
|
|
|
19
21
|
```
|
|
20
|
-
|
|
21
|
-
│ Claude Code hook
|
|
22
|
+
type /skill or AI invokes a skill
|
|
23
|
+
│ Claude Code hook fires
|
|
22
24
|
▼
|
|
23
|
-
left-skills hook(
|
|
24
|
-
- UserPromptExpansion.command_name (
|
|
25
|
-
- PreToolUse.tool_input.skill (AI
|
|
26
|
-
- UserPromptSubmit.prompt (
|
|
27
|
-
│
|
|
25
|
+
left-skills hook (3 sources)
|
|
26
|
+
- UserPromptExpansion.command_name (manual /slash)
|
|
27
|
+
- PreToolUse.tool_input.skill (AI invokes Skill tool)
|
|
28
|
+
- UserPromptSubmit.prompt (natural-language mention)
|
|
29
|
+
│ parse payload, extract skill name
|
|
28
30
|
▼
|
|
29
|
-
~/.left-skills/usage.json (append
|
|
31
|
+
~/.left-skills/usage.json (append records)
|
|
30
32
|
│
|
|
31
33
|
▼
|
|
32
|
-
left-skills usage
|
|
34
|
+
left-skills usage report (manual / AI / mention split + never-called ⚠)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
## Installation
|
|
36
38
|
|
|
37
39
|
```bash
|
|
38
40
|
npm i -g left-skills
|
|
39
|
-
left-skills install #
|
|
41
|
+
left-skills install --write # auto-config hooks into ~/.claude/settings.json (merge + backup .bak)
|
|
40
42
|
```
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
> Don't want auto-write? `left-skills install` prints a snippet to add manually. See [docs/install.md](docs/install.md).
|
|
45
|
+
|
|
46
|
+
## Uninstall
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
left-skills uninstall # remove hooks (backup .bak)
|
|
50
|
+
npm uninstall -g left-skills # remove binary
|
|
51
|
+
```
|
|
43
52
|
|
|
44
53
|
## Quick Start
|
|
45
54
|
|
|
46
55
|
```bash
|
|
47
|
-
left-skills usage #
|
|
48
|
-
left-skills usage --json # AI
|
|
49
|
-
left-skills usage --since 7 #
|
|
56
|
+
left-skills usage # human-readable report
|
|
57
|
+
left-skills usage --json # for AI (JSON)
|
|
58
|
+
left-skills usage --since 7 # last 7 days
|
|
50
59
|
```
|
|
51
60
|
|
|
52
|
-
|
|
61
|
+
Example:
|
|
53
62
|
|
|
54
63
|
```
|
|
55
|
-
skill
|
|
64
|
+
skill usage report (14 skills)
|
|
56
65
|
────────────────────────────────────
|
|
57
|
-
3 grill-me (
|
|
58
|
-
0 gitlab-ci-generate ⚠
|
|
66
|
+
3 grill-me (manual1 + AI1 + mention1, last today)
|
|
67
|
+
0 gitlab-ci-generate ⚠ never called
|
|
59
68
|
```
|
|
60
69
|
|
|
61
70
|
## Highlights
|
|
62
71
|
|
|
63
|
-
-
|
|
64
|
-
-
|
|
65
|
-
-
|
|
66
|
-
-
|
|
72
|
+
- **3-source hook tracking**: manual `/slash`, AI Skill-tool invoke, natural-language mention — tracked separately
|
|
73
|
+
- **Honest reporting**: manual/AI/mention split (no fake "call count"), never-called ⚠
|
|
74
|
+
- **For AI use**: `--json` output, AI can parse to decide (improve/delete skill)
|
|
75
|
+
- **Single-file bundle**: TS bundled to one `.js`, ships via skill ecosystem
|
|
67
76
|
|
|
68
77
|
## Limitations
|
|
69
78
|
|
|
70
|
-
-
|
|
71
|
-
- **AI
|
|
72
|
-
-
|
|
73
|
-
- MVP
|
|
79
|
+
- **Claude Code only** (Cursor / Codex later)
|
|
80
|
+
- **AI pure progressive-disclosure auto-activation** (not via Skill tool) can't be tracked — only manual `/slash` + AI Skill-tool + natural-language mention
|
|
81
|
+
- Requires hook config (user adds to settings.json)
|
|
82
|
+
- MVP stage (early, API may change)
|
|
74
83
|
|
|
75
84
|
## Contributing
|
|
76
85
|
|
|
77
|
-
|
|
86
|
+
PRs welcome. Dev setup:
|
|
78
87
|
|
|
79
88
|
```bash
|
|
80
89
|
git clone https://github.com/cuikexi/left-skills
|
|
81
90
|
cd left-skills
|
|
82
91
|
npm install
|
|
83
92
|
npm run build
|
|
84
|
-
npm link #
|
|
93
|
+
npm link # local left-skills into PATH
|
|
85
94
|
```
|
|
86
95
|
|
|
87
|
-
|
|
96
|
+
Run `npm run build` before PR to ensure dist is fresh. Philosophy / roadmap see [docs/roadmap.md](docs/roadmap.md).
|
|
88
97
|
|
|
89
98
|
## Star History
|
|
90
99
|
|
package/README.zh.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# left-skills
|
|
4
|
+
|
|
5
|
+
**shift-left for skills** — 在 skill 投入使用前就度量它用没用,而不是等用户撞 bug。
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/left-skills)
|
|
8
|
+
[](./LICENSE)
|
|
9
|
+
[](https://github.com/cuikexi/left-skills)
|
|
10
|
+
|
|
11
|
+
[English](./README.md)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
## 命名由来
|
|
16
|
+
|
|
17
|
+
`left-skills` = **shift-left for skills**。把质量/度量左移到"投入使用前"——你写完 skill,先看它用没用、写得好不好,而不是等用户撞 bug 才发现。
|
|
18
|
+
|
|
19
|
+
## How It Works
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
打 /skill 或 AI 调 skill
|
|
23
|
+
│ Claude Code hook 触发
|
|
24
|
+
▼
|
|
25
|
+
left-skills hook(三数据源)
|
|
26
|
+
- UserPromptExpansion.command_name (手动 /slash)
|
|
27
|
+
- PreToolUse.tool_input.skill (AI 调 Skill 工具)
|
|
28
|
+
- UserPromptSubmit.prompt (自然语言提及)
|
|
29
|
+
│ 解析 payload,取 skill 名
|
|
30
|
+
▼
|
|
31
|
+
~/.left-skills/usage.json (append 记录)
|
|
32
|
+
│
|
|
33
|
+
▼
|
|
34
|
+
left-skills usage 报告(手动/AI/提及 分开 + 从未调用 ⚠)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm i -g left-skills
|
|
41
|
+
left-skills install --write # 自动配 hook 到 ~/.claude/settings.json(合并去重 + 备份 .bak)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
> 不想自动写?`left-skills install` 输出片段手动加。详见 [docs/install.md](docs/install.md)。
|
|
45
|
+
|
|
46
|
+
## 卸载
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
left-skills uninstall # 删 hook(备份 .bak)
|
|
50
|
+
npm uninstall -g left-skills # 卸 binary
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Quick Start
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
left-skills usage # 人看报告
|
|
57
|
+
left-skills usage --json # AI 用(JSON)
|
|
58
|
+
left-skills usage --since 7 # 近 7 天
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
报告示例:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
skill 调用报告(14 个 skill)
|
|
65
|
+
────────────────────────────────────
|
|
66
|
+
3 grill-me (手动1 + AI1 + 提及1,最近 今天)
|
|
67
|
+
0 gitlab-ci-generate ⚠ 从未调用
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Highlights
|
|
71
|
+
|
|
72
|
+
- **三数据源 hook 埋点**:手动 `/slash`、AI 调 Skill、自然语言提及,分开记
|
|
73
|
+
- **诚实报告**:手动/AI/提及 分开标(不混"调用次数"),从未调用 ⚠
|
|
74
|
+
- **给 AI 用**:`--json` 输出,AI 能解析决策(改/删 skill)
|
|
75
|
+
- **单文件 bundle**:TS 打包单 `.js`,随 skill 生态分发
|
|
76
|
+
|
|
77
|
+
## Limitations
|
|
78
|
+
|
|
79
|
+
- 只 **Claude Code**(Cursor / Codex 后扩)
|
|
80
|
+
- **AI 纯 progressive disclosure 自主激活**(不走 Skill 工具)抓不到——只手动 `/slash` + AI 调 Skill 工具 + 自然语言提及
|
|
81
|
+
- 需装 hook 配置(用户加 settings.json)
|
|
82
|
+
- MVP 期(早期,API 可能变)
|
|
83
|
+
|
|
84
|
+
## Contributing
|
|
85
|
+
|
|
86
|
+
PR 欢迎。开发:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
git clone https://github.com/cuikexi/left-skills
|
|
90
|
+
cd left-skills
|
|
91
|
+
npm install
|
|
92
|
+
npm run build
|
|
93
|
+
npm link # 本地 left-skills 进 PATH
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
提 PR 前 `npm run build` 确保 dist 最新。理念 / roadmap 见 [docs/roadmap.md](docs/roadmap.md)。
|
|
97
|
+
|
|
98
|
+
## Star History
|
|
99
|
+
|
|
100
|
+
[](https://star-history.com/#cuikexi/left-skills&date)
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
[MIT](./LICENSE)
|
package/dist/cli.js
CHANGED
|
@@ -3248,6 +3248,26 @@ function writeHooksToSettings(settingsPath) {
|
|
|
3248
3248
|
}
|
|
3249
3249
|
(0, import_node_fs3.writeFileSync)(settingsPath, JSON.stringify(settings, null, 2) + "\n", "utf-8");
|
|
3250
3250
|
}
|
|
3251
|
+
function removeHooksFromSettings(settingsPath) {
|
|
3252
|
+
if (!(0, import_node_fs3.existsSync)(settingsPath)) return;
|
|
3253
|
+
(0, import_node_fs3.copyFileSync)(settingsPath, settingsPath + ".bak");
|
|
3254
|
+
let settings = {};
|
|
3255
|
+
try {
|
|
3256
|
+
settings = JSON.parse((0, import_node_fs3.readFileSync)(settingsPath, "utf-8"));
|
|
3257
|
+
} catch {
|
|
3258
|
+
return;
|
|
3259
|
+
}
|
|
3260
|
+
if (!settings.hooks) return;
|
|
3261
|
+
for (const event of Object.keys(settings.hooks)) {
|
|
3262
|
+
settings.hooks[event] = settings.hooks[event].filter((entry) => {
|
|
3263
|
+
entry.hooks = (entry.hooks || []).filter((h) => !(h.command && h.command.includes("left-skills")));
|
|
3264
|
+
return entry.hooks.length > 0;
|
|
3265
|
+
});
|
|
3266
|
+
if (settings.hooks[event].length === 0) delete settings.hooks[event];
|
|
3267
|
+
}
|
|
3268
|
+
if (Object.keys(settings.hooks).length === 0) delete settings.hooks;
|
|
3269
|
+
(0, import_node_fs3.writeFileSync)(settingsPath, JSON.stringify(settings, null, 2) + "\n", "utf-8");
|
|
3270
|
+
}
|
|
3251
3271
|
function globalSettingsPath() {
|
|
3252
3272
|
return (0, import_node_path3.join)((0, import_node_os3.homedir)(), ".claude", "settings.json");
|
|
3253
3273
|
}
|
|
@@ -3255,7 +3275,7 @@ function globalSettingsPath() {
|
|
|
3255
3275
|
// package.json
|
|
3256
3276
|
var package_default = {
|
|
3257
3277
|
name: "left-skills",
|
|
3258
|
-
version: "0.
|
|
3278
|
+
version: "0.2.0",
|
|
3259
3279
|
description: "\u7ED9 AI \u7528\u7684 skill \u751F\u547D\u5468\u671F\u7BA1\u7406\u5DE5\u5177 \u2014 MVP: skill \u8C03\u7528\u4F7F\u7528\u7EDF\u8BA1",
|
|
3260
3280
|
bin: {
|
|
3261
3281
|
"left-skills": "./dist/cli.js"
|
|
@@ -3320,6 +3340,12 @@ program2.command("install").description("\u8F93\u51FA hook \u914D\u7F6E\u7247\u6
|
|
|
3320
3340
|
console.log("\n# \u628A\u4E0A\u9762\u7247\u6BB5\u52A0\u8FDB ~/.claude/settings.json \u7684 hooks \u5B57\u6BB5,\u6216\u8DD1 left-skills install --write \u81EA\u52A8\u5199");
|
|
3321
3341
|
}
|
|
3322
3342
|
});
|
|
3343
|
+
program2.command("uninstall").description("\u5220 ~/.claude/settings.json \u7684 left-skills hook(\u5E72\u51C0\u5378\u8F7D,\u5907\u4EFD .bak)").action(() => {
|
|
3344
|
+
const path = globalSettingsPath();
|
|
3345
|
+
removeHooksFromSettings(path);
|
|
3346
|
+
console.log(`\u2713 left-skills hook \u5DF2\u4ECE ${path} \u5220\u9664(\u5DF2\u5907\u4EFD .bak)`);
|
|
3347
|
+
console.log(" \u518D\u8DD1 npm uninstall -g left-skills \u5378\u8F7D binary");
|
|
3348
|
+
});
|
|
3323
3349
|
program2.command("hook <event>").description("hook \u5165\u53E3(\u8BFB stdin payload)").action(async (event) => {
|
|
3324
3350
|
const payload = await readStdinPayload();
|
|
3325
3351
|
if (!payload) return;
|