luminae-helper 0.0.7 → 0.0.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/README.md +63 -49
- package/package.json +1 -1
- package/src/cli.js +16 -0
- package/src/utils/version.js +108 -0
package/README.md
CHANGED
|
@@ -1,70 +1,84 @@
|
|
|
1
1
|
# luminae-helper
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## 功能
|
|
6
|
-
|
|
7
|
-
- **多选交互**:Skill 和目标工具均支持 Checkbox 多选
|
|
8
|
-
- **自动检测**:自动检测本机已安装的 AI 工具
|
|
9
|
-
- **导航支持**:每个步骤均支持返回上一步和退出
|
|
10
|
-
- Checkbox 步骤:Esc 返回上一步,Ctrl+C 退出
|
|
11
|
-
- 预览确认步骤:显式选项(确认/返回/退出)
|
|
12
|
-
- **安装/卸载**:支持安装和卸载操作
|
|
13
|
-
|
|
14
|
-
## 支持的工具
|
|
15
|
-
|
|
16
|
-
| 工具 | 命令 | Skill 安装方式 |
|
|
17
|
-
|------|------|---------------|
|
|
18
|
-
| Claude Code | `claude` | `~/.claude/commands/<skill>.md` |
|
|
19
|
-
| Cursor | `cursor` | `~/.cursor/commands/<skill>.md` |
|
|
20
|
-
| OpenCode | `opencode` | `~/.opencode/skills/<skill>/` (目录) |
|
|
21
|
-
| Trae | `trae` | `~/.trae/commands/<skill>.md` |
|
|
22
|
-
| OpenClaw | `openclaw` | `~/.openclaw/skills/<skill>/` (目录) |
|
|
23
|
-
| Nanobot | `nanobot` | `~/.nanobot/skills/<skill>/` (目录) |
|
|
24
|
-
| Hermes Agent | `hermes` | `~/.hermes/skills/<skill>/` (目录) |
|
|
25
|
-
| ZeroClaw | `zeroclaw` | `~/.zeroclaw/skills/<skill>/` (目录) |
|
|
3
|
+
将 AI skill 安装到本地 AI 编码工具的交互式 CLI。
|
|
26
4
|
|
|
27
5
|
## 安装
|
|
28
6
|
|
|
29
7
|
```bash
|
|
30
|
-
|
|
31
|
-
cd tools/luminae-helper
|
|
32
|
-
|
|
33
|
-
# 安装依赖
|
|
34
|
-
npm install
|
|
35
|
-
|
|
36
|
-
# 链接到全局(可选)
|
|
37
|
-
npm link
|
|
8
|
+
npm install -g luminae-helper
|
|
38
9
|
```
|
|
39
10
|
|
|
40
11
|
## 使用
|
|
41
12
|
|
|
42
13
|
```bash
|
|
43
|
-
#
|
|
44
|
-
node src/cli.js
|
|
45
|
-
|
|
46
|
-
# 或链接后
|
|
14
|
+
# 交互模式(默认)
|
|
47
15
|
luminae-helper
|
|
16
|
+
|
|
17
|
+
# 查看版本
|
|
18
|
+
luminae-helper --version
|
|
19
|
+
luminae-helper -v
|
|
20
|
+
|
|
21
|
+
# 检查是否有新版本
|
|
22
|
+
luminae-helper outdated
|
|
48
23
|
```
|
|
49
24
|
|
|
25
|
+
## 功能
|
|
26
|
+
|
|
27
|
+
- **多选交互**:skill 和目标工具均支持 Checkbox 多选
|
|
28
|
+
- **自动检测**:通过 `which`/`where` 检测本机已安装的 AI 工具
|
|
29
|
+
- **安装防护**:往 SKILL.md 注入 `managed-by: luminae-helper` 标识,卸载时校验,避免误删用户文件
|
|
30
|
+
- **失败重试**:安装失败自动重试 2 次;"不支持"等不可重试项单独汇总
|
|
31
|
+
- **原子替换**:dir 模式安装先拷到临时目录,再 rename 替换;失败可回滚
|
|
32
|
+
|
|
33
|
+
## 支持的 AI 工具
|
|
34
|
+
|
|
35
|
+
| 工具 | 命令 | commandDir | skillDir |
|
|
36
|
+
|------|------|-----------|----------|
|
|
37
|
+
| Claude Code | `claude` | `~/.claude/commands/` | `~/.claude/skills/` |
|
|
38
|
+
| Codex | `codex` | — | `~/.codex/skills/` |
|
|
39
|
+
| Cursor | `cursor` | — | `~/.cursor/skills/` |
|
|
40
|
+
| Hermes Agent | `hermes` | — | `~/.hermes/skills/` |
|
|
41
|
+
| OpenCode | `opencode` | — | `~/.opencode/skills/` |
|
|
42
|
+
| Trae | `trae` | `~/.trae/commands/` | — |
|
|
43
|
+
|
|
44
|
+
## 包含的 skill
|
|
45
|
+
|
|
46
|
+
本版本包含以下通用 skill:
|
|
47
|
+
|
|
48
|
+
- `identity` — 项目类型检测与 agent 身份设定
|
|
49
|
+
- `git-commit` — Git commit 流程
|
|
50
|
+
- `git-commit-msg` — Git commit message 生成
|
|
51
|
+
- `git-push` — Git push 流程
|
|
52
|
+
|
|
50
53
|
## 操作流程
|
|
51
54
|
|
|
52
|
-
1.
|
|
53
|
-
2. 多选
|
|
54
|
-
3.
|
|
55
|
-
4.
|
|
56
|
-
5.
|
|
55
|
+
1. 主菜单:选择 **安装** 或 **卸载**
|
|
56
|
+
2. 多选 skill/command(空格切换勾选,回车确认)
|
|
57
|
+
3. 多选目标工具(仅显示本机已安装的)
|
|
58
|
+
4. 预览确认
|
|
59
|
+
5. 执行;失败时自动重试可重试项
|
|
60
|
+
|
|
61
|
+
任何步骤可用 Esc 返回上一步、Ctrl+C 退出。
|
|
62
|
+
|
|
63
|
+
## 安装规则
|
|
64
|
+
|
|
65
|
+
源目录决定优先安装方式,工具能力决定 fallback:
|
|
66
|
+
|
|
67
|
+
| skill 源 | 工具能力 | 安装方式 |
|
|
68
|
+
|---------|---------|---------|
|
|
69
|
+
| `commands/` | 支持 commandDir | file 模式:`commandDir/<id>.md` |
|
|
70
|
+
| `commands/` | 仅支持 skillDir | dir 模式(fallback):`skillDir/<id>/` |
|
|
71
|
+
| `skills/` | 支持 skillDir | dir 模式:`skillDir/<id>/` |
|
|
72
|
+
| `skills/` | 仅支持 commandDir | file 模式(fallback):`commandDir/<id>.md` |
|
|
73
|
+
|
|
74
|
+
例:Claude Code(双模式)→ `commands/identity` 装到 `~/.claude/commands/identity.md`。
|
|
57
75
|
|
|
58
|
-
|
|
59
|
-
- Checkbox 步骤:列表底部显示导航项(灰显,不可勾选),Esc 返回上一步,Ctrl+C 退出
|
|
60
|
-
- 确认步骤:显式选择「返回上一步」或「退出」
|
|
76
|
+
## 源码与变更
|
|
61
77
|
|
|
62
|
-
|
|
78
|
+
源码:https://github.com/evenweiss/ai-toolkit/tree/main/tools/luminae-helper
|
|
63
79
|
|
|
64
|
-
|
|
65
|
-
2. 在 `tools/luminae-helper` 下执行 `npm install` 或 `npm run sync-skills`,会把根目录 `skills/` 同步到本包内的 `skills/`(该目录已 `.gitignore`,勿在包内手改副本)。
|
|
66
|
-
3. Skill 元数据与安装目标由 `src/lib/constants.js` 的 `discoverSkills()` 自动扫描包内 `skills/` 生成,一般无需再手写 `SKILLS` 数组。
|
|
80
|
+
变更日志:[CHANGELOG.md](./CHANGELOG.md)
|
|
67
81
|
|
|
68
|
-
##
|
|
82
|
+
## License
|
|
69
83
|
|
|
70
|
-
|
|
84
|
+
MIT
|
package/package.json
CHANGED
package/src/cli.js
CHANGED
|
@@ -1,7 +1,23 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
3
|
import { runInteractive, TERM_GUTTER } from "./lib/ui.js";
|
|
4
|
+
import { printVersion, checkOutdated } from "./utils/version.js";
|
|
4
5
|
|
|
6
|
+
const args = process.argv.slice(2);
|
|
7
|
+
|
|
8
|
+
// --version / -v
|
|
9
|
+
if (args.includes("--version") || args.includes("-v")) {
|
|
10
|
+
printVersion();
|
|
11
|
+
process.exit(0);
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
// outdated 子命令
|
|
15
|
+
if (args[0] === "outdated") {
|
|
16
|
+
await checkOutdated();
|
|
17
|
+
process.exit(0);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// 默认:交互模式
|
|
5
21
|
async function main() {
|
|
6
22
|
try {
|
|
7
23
|
await runInteractive();
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { readFileSync } from "fs";
|
|
2
|
+
import { join } from "path";
|
|
3
|
+
import chalk from "chalk";
|
|
4
|
+
|
|
5
|
+
export const TERM_GUTTER = " ";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* 读取当前包的 package.json。
|
|
9
|
+
* import.meta.dirname = <package>/src/utils
|
|
10
|
+
* package.json 在 <package>/,需要上跳两级
|
|
11
|
+
*/
|
|
12
|
+
function readPackageJson() {
|
|
13
|
+
const pkgPath = join(import.meta.dirname, "..", "..", "package.json");
|
|
14
|
+
return JSON.parse(readFileSync(pkgPath, "utf-8"));
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* 获取当前包名。
|
|
19
|
+
*/
|
|
20
|
+
export function getPackageName() {
|
|
21
|
+
return readPackageJson().name;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* 获取当前版本号。
|
|
26
|
+
*/
|
|
27
|
+
export function getVersion() {
|
|
28
|
+
return readPackageJson().version;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* 获取当前包的 registry URL。
|
|
33
|
+
* 优先读 publishConfig.registry,否则用 npm 默认 registry。
|
|
34
|
+
*/
|
|
35
|
+
function getRegistry() {
|
|
36
|
+
const pkg = readPackageJson();
|
|
37
|
+
return pkg.publishConfig?.registry || "https://registry.npmjs.org/";
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* 从 registry 查询指定包的最新版本。
|
|
42
|
+
* @param {string} packageName
|
|
43
|
+
* @param {string} registry
|
|
44
|
+
* @returns {Promise<string|null>} 最新版本号,查询失败返回 null
|
|
45
|
+
*/
|
|
46
|
+
async function fetchLatestVersion(packageName, registry) {
|
|
47
|
+
const url = `${registry}${packageName}`;
|
|
48
|
+
try {
|
|
49
|
+
const res = await fetch(url, {
|
|
50
|
+
signal: AbortSignal.timeout(8000),
|
|
51
|
+
headers: { Accept: "application/json" },
|
|
52
|
+
});
|
|
53
|
+
if (!res.ok) return null;
|
|
54
|
+
const data = await res.json();
|
|
55
|
+
// npmjs 返回 data["dist-tags"].latest,私有 registry 格式类似
|
|
56
|
+
return data?.["dist-tags"]?.latest ?? data?.version ?? null;
|
|
57
|
+
} catch {
|
|
58
|
+
return null;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* 比较两个 semver 版本号(简单比较,仅支持 x.y.z 格式)。
|
|
64
|
+
* @returns {number} 正数=a>b, 0=相等, 负数=a<b
|
|
65
|
+
*/
|
|
66
|
+
function compareSemver(a, b) {
|
|
67
|
+
const pa = a.replace(/^v/, "").split(".").map(Number);
|
|
68
|
+
const pb = b.replace(/^v/, "").split(".").map(Number);
|
|
69
|
+
for (let i = 0; i < 3; i++) {
|
|
70
|
+
if ((pa[i] || 0) !== (pb[i] || 0)) return (pa[i] || 0) - (pb[i] || 0);
|
|
71
|
+
}
|
|
72
|
+
return 0;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* 打印当前版本号。
|
|
77
|
+
*/
|
|
78
|
+
export function printVersion() {
|
|
79
|
+
const pkg = readPackageJson();
|
|
80
|
+
console.log(`${pkg.name}@${pkg.version}`);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* 检查是否有新版本并输出提示。
|
|
85
|
+
*/
|
|
86
|
+
export async function checkOutdated() {
|
|
87
|
+
const pkg = readPackageJson();
|
|
88
|
+
const currentVersion = pkg.version;
|
|
89
|
+
const packageName = pkg.name;
|
|
90
|
+
const registry = getRegistry();
|
|
91
|
+
|
|
92
|
+
console.log(TERM_GUTTER + `当前版本: ${packageName}@${currentVersion}`);
|
|
93
|
+
console.log(TERM_GUTTER + `检查更新中...`);
|
|
94
|
+
|
|
95
|
+
const latestVersion = await fetchLatestVersion(packageName, registry);
|
|
96
|
+
|
|
97
|
+
if (!latestVersion) {
|
|
98
|
+
console.log(chalk.yellow(TERM_GUTTER + "⚠ 无法获取最新版本信息,请检查网络连接"));
|
|
99
|
+
return;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
if (compareSemver(currentVersion, latestVersion) >= 0) {
|
|
103
|
+
console.log(chalk.green(TERM_GUTTER + `✓ 已是最新版本 (${currentVersion})`));
|
|
104
|
+
} else {
|
|
105
|
+
console.log(chalk.yellow(TERM_GUTTER + `⚠ 发现新版本: ${latestVersion}(当前: ${currentVersion})`));
|
|
106
|
+
console.log(TERM_GUTTER + ` 更新命令: npm install -g ${packageName}`);
|
|
107
|
+
}
|
|
108
|
+
}
|