cli-blueprint 0.2.2 → 0.2.3

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 DELETED
@@ -1,147 +0,0 @@
1
- # cli-blueprint
2
-
3
- **多 skill 多 IDE 安装器** —— 一条命令从 cli.tax 拉取并分发到本机所有已装 IDE,可无限扩展。
4
-
5
- ```bash
6
- npx cli-blueprint@latest install
7
- ```
8
-
9
- 默认包含:
10
- - `blueprint`(CLI.Tax 工程规划 skill,`https://cli.tax/wvz6zmRWmX`)
11
- - `calctool`(万能计算工具生成器,`https://cli.tax/KKyA6xljUX`)
12
-
13
- ## 这是什么机制?
14
-
15
- clitaxio 的本质只是从 `https://cli.tax/api/public/skills/{code}` 下载两个文件
16
- (`SKILL.md` + `skill.json`)并写入 IDE 的 skills 目录。本包把这个过程**固化成一个可版本化、
17
- 可分发、可扩展的本地插件包**,并打通了 cli.tax 生态:
18
-
19
- - **自动拉取**:`sources.json` 里配置 cli.tax skill 源(如 `wvz6zmRWmX`),
20
- `node install.mjs pull` 或 install 时自动从 cli.tax 拉取最新内容到 `skills/`(可提交进 git)
21
- - **自动匹配分发**:每个 skill 是一个目录:`skills/<name>/SKILL.md`;安装器自动检测本机
22
- 真实安装的 IDE,把 skill 分发到各 IDE 自己的用户级根(如 Codex 扫 `~/.codex/skills`、
23
- DSH 扫 `~/.dsh/skills`),各一份、互不干扰
24
- - 共享兼容根 `~/.agents/skills` 默认跳过——它会被多个工具扫描,是"同一 skill 重复出现"的根源
25
-
26
- **与 clitaxio 的区别**:clitaxio 只把 skill 装到**一个** IDE 目录;本包是"拉取 + 多 IDE 自动分发",
27
- 装一次,本机所有已装 IDE 都能用。
28
-
29
- ## 安装 / 更新 / 卸载
30
-
31
- ```bash
32
- # 本地运行(无需发布)
33
- node install.mjs pull # 从 cli.tax(sources.json)拉取最新 skill 到 skills/,可 git 提交
34
- node install.mjs install # 自动匹配:skills/ 为空时自动先 pull,再分发到本机已装 IDE
35
- node install.mjs install --all # 装到所有已知 IDE(不管是否安装)
36
- node install.mjs install --ide codex --ide dsh # 只装指定 IDE(可重复)
37
- node install.mjs install --skip cursor # 自动匹配但跳过指定 IDE(可重复)
38
- node install.mjs install --pull # 强制重新从 cli.tax 拉取后再安装
39
- node install.mjs install --project # 额外装到当前项目的项目级根
40
- node install.mjs install --agents # 额外装到共享 ~/.agents/skills(警告:可能被多工具重复发现)
41
- node install.mjs install --target /abs/path # 只装到自定义目录
42
- node install.mjs update # 幂等覆盖,等同 install
43
- node install.mjs list # 列出包内 skills
44
- node install.mjs ides # 查看已知 IDE 及本机检测结果(✓ = 本机已装)
45
- node install.mjs uninstall # 从相同目标卸载本包安装的 skills
46
- ```
47
-
48
- **自动匹配说明**:默认安装会探测本机真实安装的 IDE(`which` 命令 / 应用路径 / 配置文件),
49
- 只装给已安装的 IDE,让每个 IDE 自己识别需要的 skill。用 `node install.mjs ides` 查看
50
- 本机检测结果(✓ = 已安装)。
51
-
52
- ## 支持的 IDE(全世界已知安装位置,官方文档核实)
53
-
54
- | IDE | 用户级根 | 项目级根 | 说明 |
55
- |---|---|---|---|
56
- | Codex CLI | `~/.codex/skills` | `.codex/skills` | 新官方约定 `~/.agents/skills`;此处用专属根避免共享冲突 |
57
- | DSH | `~/.dsh/skills` | `.dsh/skills` | skill-filesystem 自动扫描 |
58
- | Claude Code | `~/.claude/skills` | `.claude/skills` | 父目录向上扫描至 repo root |
59
- | Gemini CLI | `~/.gemini/skills` | `.gemini/skills` | 别名 `.agents/skills` 优先级更高 |
60
- | Google Antigravity | `~/.gemini/antigravity/skills` | `.agents/skills`(随 --agents) | workspace 级固定用 agents 标准 |
61
- | Cursor | `~/.cursor/skills` | `.cursor/skills` | 兼容加载 .claude/.codex/.agents/skills |
62
- | Cline | `~/.cline/skills` | `.cline/skills` | 全局优先于项目 |
63
- | Roo Code | `~/.roo/skills` | `.roo/skills` | 项目覆盖全局 |
64
- | Kilo Code | `~/.kilo/skills` | `.kilo/skills` | kilo.jsonc 可配 |
65
- | Windsurf | `~/.codeium/windsurf/skills` | `.windsurf/skills` | Cascade Skills |
66
- | VS Code / Copilot | `~/.copilot/skills` | `.github/skills` | 另兼容 .claude/skills |
67
- | Trae | `~/.trae-cn/skills`(国内版) | `.trae/skills` | 国际版用户级未确认 |
68
- | Qwen Code | `~/.qwen/skills` | `.qwen/skills` | 模型自动调用 |
69
- | OpenCode | `~/.config/opencode/skills` | `.opencode/skills` | 兼容 .claude/.agents |
70
- | Zed | `~/.agents/skills`(仅 --agents) | `.agents/skills`(仅 --agents) | 官方即用 agents 标准根 |
71
- | Amazon Q | 无 skills 机制 | 无 skills 机制 | 官方确认不支持 SKILL.md |
72
-
73
- > 跨工具互操作标准根 `~/.agents/skills`(agentskills.io):Codex 新约定、Gemini、Zed、
74
- > OpenCode、Cursor、Antigravity、Kilo 等都支持,但会被**多个工具同时扫描**——同一 skill
75
- > 装进去会在各工具中重复出现。本安装器默认跳过它(`--agents` 显式开启并警告)。
76
- >
77
- > 新增 IDE:在 `install.mjs` 的 `IDES` 数组加一行即可,其余逻辑自动生效。
78
-
79
- ## 分发给别人
80
-
81
- ### 方式 A:npm 一条命令(推荐,最简单)
82
- 已发布到 npm(`cli-blueprint@0.2.1` / `cli-calctool@0.1.1`),使用者只需:
83
- ```bash
84
- npx cli-blueprint@latest install # 装 blueprint + calctool 两个 skill
85
- npx cli-calctool@latest install # 同样内容(calctool 命名入口)
86
- ```
87
- 自动完成:从 cli.tax 拉取 blueprint + calctool → 检测本机已装 IDE → 分发到每个 IDE。
88
- 更新:同一命令(`@latest` 自动拉新版),且每次 install 会对比 cli.tax 最新版本并提示 ⤴。
89
-
90
- ### 方式 B:Git 仓库
91
- ```bash
92
- git clone https://github.com/88208555/Blueprint-clitax.git
93
- cd Blueprint-clitax
94
- node install.mjs install
95
- ```
96
- 更新:`git pull && node install.mjs update`(install/update 会对比已装版本与 cli.tax 最新版本并提示)。
97
-
98
- ### 更新感知(check)
99
- 安装器写入 `install-meta.json`(来源/版本/时间)到每个 skill 目录;SKILL.md 注入版本横幅,
100
- IDE 每次读取即可见版本与更新入口。主动检查:
101
- ```bash
102
- node install.mjs check # 遍历本机已装 IDE,对比 cli.tax 最新版本
103
- npx cli-blueprint@latest check # 单包检查(calctool 同理)
104
- ```
105
-
106
- ### 方式 C:直接用 clitaxio(只装单个 IDE,作为对照)
107
- ```bash
108
- npx clitaxio@latest install wvz6zmRWmX
109
- ```
110
- > ⚠️ 注意:clitaxio **只把 skill 装到默认的 Codex 目录**(单一 IDE),不会自动检测/分发到
111
- > 其他 IDE,也不处理 `~/.agents/skills` 共享根重复问题。需要多 IDE 分发请用方式 A/B。
112
-
113
- ## 目录结构
114
-
115
- ```
116
- cli-blueprint/
117
- ├── install.mjs # 安装器(Node ≥18,零依赖):pull / install / uninstall / list / ides
118
- ├── sources.json # ★ cli.tax skill 源清单(code → 自动拉取),扩展就加一行
119
- ├── package.json # npm 包元数据(cli-blueprint)
120
- ├── README.md
121
- └── skills/ # skill 内容(pull 生成,可提交 git 离线兜底)
122
- └── blueprint/
123
- ├── SKILL.md
124
- └── skill.json
125
- ```
126
-
127
- ## 无限扩展(加新 skill 两种方式)
128
-
129
- **方式 A:从 cli.tax 拉取**(推荐)——`sources.json` 加一行:
130
- ```json
131
- { "cliTax": [
132
- { "code": "wvz6zmRWmX", "slug": "blueprint", "endpoint": "https://cli.tax/api/public/skills/{code}" },
133
- { "code": "你的新code", "slug": "新skill名", "endpoint": "https://cli.tax/api/public/skills/{code}" }
134
- ] }
135
- ```
136
- 然后 `node install.mjs pull` → 自动下载到 skills/。
137
-
138
- **方式 B:本地手工写**——直接建 `skills/my-new-skill/SKILL.md`(frontmatter: `name` kebab-case + `description`)。
139
-
140
- 两种方式后都只需 `node install.mjs update` 同步到本机所有已装 IDE。
141
-
142
- ## 常见问题
143
-
144
- - **装完当前会话没立刻出现?** skill 目录在会话初始化时注入,新会话即可发现;文件系统 watcher 也会自动感知变更。
145
- - **Codex 里出现了 2 个同一个 skill?** 常见原因是同时存在 `~/.codex/skills/<name>` 和 `~/.agents/skills/<name>`(或 config.toml 注册条目)。本安装器默认不会装到 `~/.agents/skills`,避免此问题;如已发生,删除 `~/.agents/skills/<name>` 并清理 config.toml 中的 `[[skills.config]]` 条目即可。
146
- - **想改 skill 内容?** 直接改 `skills/<name>/SKILL.md` 再 `update`,幂等覆盖。
147
- - **命名要求?** 目录名即 skill 名,必须 kebab-case(如 `my-new-skill`)。