luminae-helper 0.0.8 → 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.
Files changed (2) hide show
  1. package/README.md +63 -49
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,70 +1,84 @@
1
1
  # luminae-helper
2
2
 
3
- AI Skill 安装器 — 将 ai-toolkit 项目中的 skill 安装到本地 AI 编码工具。
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. 多选 Skill(Checkbox,空格切换,回车确认)
54
- 3. 多选目标工具(Checkbox,仅显示已安装的工具)
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
- ## 添加新的 Skill
78
+ 源码:https://github.com/evenweiss/ai-toolkit/tree/main/tools/luminae-helper
63
79
 
64
- 1. 在 **仓库根目录**(与 `tools/` 同级)创建 `skills/skill-your-skill/SKILL.md`(及可选 `README.md` 等)。此处为 Git 中的**唯一真源**。
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
- ## 发布 npm 包
82
+ ## License
69
83
 
70
- `prepublishOnly` 会在发布前以 `--strict` 运行同步:必须在 monorepo 中能找到根目录 `skills/`,否则发布失败,避免打出不含 Skill 的空包。
84
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "luminae-helper",
3
- "version": "0.0.8",
3
+ "version": "0.0.9",
4
4
  "description": "Install AI skills to coding tools (Claude Code, Cursor, OpenCode, Trae, etc.)",
5
5
  "type": "module",
6
6
  "main": "src/cli.js",