Skip to content

Commit 0e33c70

Browse files
committed
docs: update skill installation instructions to use bl skill add
- Replace all instances of `npx skills add modelstudioai/cli --all -g` with `bl skill add --name all` - Update installation documentation in INSTALL.md, README.md, and related files - Modify code references in config/inventory.ts, generate-reference.ts, and other files - Update HTML UI messages to reflect new installation command - Correct setup.md to include binary installation option and update subset install instructions - Adjust versioning documentation to use new skill installation command - Update all SKILL.md files with consistent installation instructions
1 parent 6338df3 commit 0e33c70

24 files changed

Lines changed: 79 additions & 80 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ packages/core/src/auth/ # apiKey / console credential 解析与落盘
3535
packages/core/src/client/ # HTTP client / endpoints / console gateway
3636
```
3737

38-
Skill / 命令手册随 `skills/bailian-*/``npx skills add modelstudioai/cli --all -g` 安装(整包装齐,含共享协议 `bailian-protocol`)。业务 skill(`bailian-cli` / `bailian-gen` / `bailian-finetune` / `bailian-managed-agent`)执行前读 `skills/bailian-protocol/`;不要依赖 frontmatter `companions`(安装器不强制)。`tools/generate-reference.ts`**`packages/cli/src/commands.ts`** 按一级命令归属表分流写入各 `skills/<skill>/reference/`(纳入 git);`tools/sync-skill-metadata.ts``packages/cli/package.json` 同步各 `skills/*/SKILL.md``metadata.version`。两者由根脚本 `pnpm run sync:skill-assets``.vite-hooks/pre-commit` 执行。hub `bailian-cli` 的路由表不复述领域命令明细;SKILL 文案 / 安装约定 / hand-off 见 [docs/agents/skill-change.md](docs/agents/skill-change.md)
38+
Skill / 命令手册随 `skills/bailian-*/``bl skill add --name all` 安装(整包装齐,含共享协议 `bailian-protocol`)。业务 skill(`bailian-cli` / `bailian-gen` / `bailian-finetune` / `bailian-managed-agent`)执行前读 `skills/bailian-protocol/`;不要依赖 frontmatter `companions`(安装器不强制)。`tools/generate-reference.ts`**`packages/cli/src/commands.ts`** 按一级命令归属表分流写入各 `skills/<skill>/reference/`(纳入 git);`tools/sync-skill-metadata.ts``packages/cli/package.json` 同步各 `skills/*/SKILL.md``metadata.version`。两者由根脚本 `pnpm run sync:skill-assets``.vite-hooks/pre-commit` 执行。hub `bailian-cli` 的路由表不复述领域命令明细;SKILL 文案 / 安装约定 / hand-off 见 [docs/agents/skill-change.md](docs/agents/skill-change.md)
3939

4040
约定:
4141

INSTALL.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,18 @@ npm install -g bailian-cli
5151

5252
4. 校验:`bl --version`
5353

54-
可选 skills(CLI 本体无关,按需):
54+
安装 skills(CLI 内置,无需 Git / npx skills):
5555

5656
```bash
57-
npx skills add modelstudioai/cli --all -g
57+
bl skill add --name all
5858
```
5959

60-
**Supported:** 始终使用 `--all -g`一次装齐整套 `bailian-*`(含共享协议 `bailian-protocol`。Agent Skills / `npx skills` **不会**按 metadata 自动拉依赖
60+
**Supported:** `--name all` 一次装齐整套 `bailian-*`(含共享协议 `bailian-protocol`)。
6161

62-
**Advanced / 不推荐** 子集 `-s` 时 skills CLI 不会自动带上 `bailian-protocol`;若坚持子集,必须手动同时指定,例如:
62+
**Advanced / 按需子集**
6363

6464
```bash
65-
# Advanced: you MUST include bailian-protocol yourself — installer does not pull it
66-
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-gen
65+
bl skill add --name bailian-protocol,bailian-gen
6766
```
6867

6968
安装成功后,用中文简要说明已安装的 skills 及用户可做什么。

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ irm https://bailian.aliyun.com/cli/install.ps1 | iex
8787
npm install -g bailian-cli
8888

8989
# Agent skills
90-
npx skills add modelstudioai/cli --all -g
90+
bl skill add --name all
9191
```
9292

9393
> Binary install does not require Node.js. `npm install -g` remains fully supported.

README.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ irm https://bailian.aliyun.com/cli/install.ps1 | iex
8585
npm install -g bailian-cli
8686

8787
# Agent skills
88-
npx skills add modelstudioai/cli --all -g
88+
bl skill add --name all
8989
```
9090

9191
> 二进制安装不依赖 Node.js。`npm install -g` 长期保留。

docs/agents/skill-change.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@
1111

1212
## 统一口径(安装)
1313

14-
1. **Supported install:** `npx skills add modelstudioai/cli --all -g`(整包装齐,含 `bailian-protocol`
15-
2. **`bailian-protocol` 是共享协议 skill**,业务 skill 执行前应 Read 它;Agent Skills / `npx skills` **不会**按 frontmatter 自动拉依赖
14+
1. **Supported install:** `bl skill add --name all`(整包装齐,含 `bailian-protocol`
15+
2. **`bailian-protocol` 是共享协议 skill**,业务 skill 执行前应 Read 它
1616
3. **不要**在 frontmatter 写 `companions`,也不要对外说「companions = 安装器硬依赖」
17-
4. 子集安装`-s`)为 **advanced / 不推荐**:skills CLI 不会自动带上 protocol;漏装会导致相对路径 Read 失败
17+
4. 子集安装`bl skill add --name bailian-protocol,<skill>`;漏装 protocol 会导致相对路径 Read 失败
1818

1919
## 概念图
2020

2121
```text
2222
bailian-protocol ← 共享协议(consent / 鉴权 / 版本 / 错误上报)
23-
▲ 靠 --all -g 与业务 skill 同装;非安装器强制 companions
23+
▲ 靠 `bl skill add --name all` 与业务 skill 同装;非安装器强制 companions
2424
2525
┌───────┴────────┬────────────────┬──────────────────┐
2626
bailian-gen bailian-finetune bailian-managed-agent
@@ -37,18 +37,18 @@ bailian-gen bailian-finetune bailian-managed-agent
3737

3838
### A. 分层边界
3939

40-
- [ ] **整包装齐**:安装/升级文案主推 `--all -g`;业务 skill ****声明 `companions`
41-
- [ ] **协议读取**:CRITICAL / references 可链 `../bailian-protocol/…`;若读不到 → 停止执行 `bl`,提示 `npx skills add modelstudioai/cli --all -g`
40+
- [ ] **整包装齐**:安装/升级文案主推 `bl skill add --name all`;业务 skill ****声明 `companions`
41+
- [ ] **协议读取**:CRITICAL / references 可链 `../bailian-protocol/…`;若读不到 → 停止执行 `bl`,提示 `bl skill add --name all`
4242
- [ ] **软 hand-off**:兄弟业务 skill **只写 skill 名**;已安装则 Read,未安装则 `bl … --help` 或提示整包安装;**不要**`../bailian-gen/…` 等写成执行前提
4343
- [ ] **Hub vs 领域**`bailian-cli` 的「When to use which command」只列 hub 拥有的意图;媒体 / 精调 / managed-agent 各留 hand-off 行,**不抄**领域默认模型与子命令明细
4444
- [ ] **渐进披露**:SKILL 写意图路由与领域硬规则;flags / usage / examples 以 `reference/``bl <command> --help` 为准,表后保留「勿猜 flag」指向句
4545

4646
### B. 文案与落款一致性
4747

4848
- [ ] 领域 skill(gen / finetune / managed-agent)路由或命令表后有指向 `reference/` 的句;文末 `## references`(protocol + reference)与家族对齐
49-
- [ ] description 含 WHAT + WHEN + 反触发;安装说明指向 `--all -g`,不写 companions 必装
49+
- [ ] description 含 WHAT + WHEN + 反触发;安装说明指向 `bl skill add --name all`,不写 companions 必装
5050
- [ ] Quick examples 只演示本 skill 职责(hub 不示范 `bl image` / `bl video` 等)
51-
- [ ] 若改了安装方式:同步 `README.md` / `README.zh.md` / `INSTALL.md` / `skills/*/README*` / `skills/bailian-protocol/assets/setup.md` 中的 `npx skills add …` 示例(改 `INSTALL.md` 时按 [install-doc-change.md](install-doc-change.md) 同步静态页)
51+
- [ ] 若改了安装方式:同步 `README.md` / `README.zh.md` / `INSTALL.md` / `skills/*/README*` / `skills/bailian-protocol/assets/setup.md` 中的 `bl skill add …` 示例(改 `INSTALL.md` 时按 [install-doc-change.md](install-doc-change.md) 同步静态页)
5252

5353
### C. 归属与生成
5454

@@ -60,16 +60,16 @@ bailian-gen bailian-finetune bailian-managed-agent
6060

6161
```sh
6262
pnpm run sync:skill-assets
63-
# 本地试装(测本仓库改动,勿只拉远端)
64-
npx skills add "$(pwd)" --all -g -y
63+
# 已发布版本试装
64+
bl skill add --name all
6565
```
6666

6767
抽查:打开 `skills/bailian-cli/SKILL.md` 确认无领域子命令明细表、无 `companions`;打开对应领域 skill 确认有「勿猜 flag」与 hand-off。
6868

6969
## 常见漏点
7070

7171
- ✗ hub 路由表再次抄回 image / video / finetune / managed-agent 明细 → token 膨胀且与领域 skill 双份漂移
72-
- ✗ 重新加回 `companions` 并宣称安装器硬依赖 → 与 Agent Skills / `npx skills` 合同不符
72+
- ✗ 重新加回 `companions` 并宣称安装器硬依赖 → 与 `bl skill add` 合同不符
7373
- ✗ 软 hand-off 写成硬路径 `../bailian-*/SKILL.md` 当执行前提 → 子集安装断链
7474
- ✗ 只改 SKILL、忘改 `GROUP_OWNER_SKILL` → reference 落错 skill
7575
- ✗ 手改 `skills/*/reference/*.md` → 下次 generate 被覆盖

packages/cli/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ irm https://bailian.aliyun.com/cli/install.ps1 | iex
8787
npm install -g bailian-cli
8888

8989
# Agent skills
90-
npx skills add modelstudioai/cli --all -g
90+
bl skill add --name all
9191
```
9292

9393
> Binary install does not require Node.js. `npm install -g` remains fully supported.

packages/cli/README.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ irm https://bailian.aliyun.com/cli/install.ps1 | iex
8585
npm install -g bailian-cli
8686

8787
# Agent skills
88-
npx skills add modelstudioai/cli --all -g
88+
bl skill add --name all
8989
```
9090

9191
> 二进制安装不依赖 Node.js。`npm install -g` 长期保留。

packages/commands/src/commands/config/inventory.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Read-only discovery of locally installed AI tooling, surfaced by `config ui`:
2-
// - Agent skills installed under ~/.agents/skills (via `npx skills add`).
2+
// - Agent skills installed under ~/.agents/skills (via `bl skill add`).
33
// - MCP servers declared in each coding agent's local config file.
44
// - Coding agent frameworks and whether the bailian-cli provider is wired in.
55
//
@@ -128,8 +128,8 @@ function countFiles(dir: string, budget = 500): number {
128128
}
129129

130130
/**
131-
* Skill directories to scan, keyed by the module that owns them. `npx skills
132-
* add --all` fans skills out into each installed agent, so the same skill can
131+
* Skill directories to scan, keyed by the module that owns them. `bl skill
132+
* add --name all` fans skills out into each installed agent, so the same skill can
133133
* live in several of these roots at once.
134134
*/
135135
function skillRoots(home: string): Array<{ source: string; dir: string }> {

packages/commands/src/commands/config/ui-html.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ export const PAGE_HTML = `<!doctype html>
548548
<section id="view-skills" class="view">
549549
<div class="view-head">
550550
<h2 class="view-title">Installed <span class="grad">Skills</span></h2>
551-
<p class="view-sub">Agent skills discovered across every local agent module (~/.agents/skills plus each agent's skills folder). Installed via <code style="font-family:var(--mono)">npx skills add</code>.</p>
551+
<p class="view-sub">Agent skills discovered across every local agent module (~/.agents/skills plus each agent's skills folder). Installed via <code style="font-family:var(--mono)">bl skill add</code>.</p>
552552
</div>
553553
<div class="toolbar"><input id="skillSearch" class="search" type="search" placeholder="Search skills…" autocomplete="off"><button id="addSkillBtn" class="btn-dark" type="button">+ Add skill</button></div>
554554
<div id="skillsBody"><div class="loading">Loading…</div></div>
@@ -1444,7 +1444,7 @@ export const PAGE_HTML = `<!doctype html>
14441444
function renderSkills() {
14451445
var body = document.getElementById('skillsBody');
14461446
var pager = document.getElementById('skillsPager');
1447-
if (!SKILLS.length) { pager.innerHTML = ''; renderEmpty(body, 'No skills installed.', 'Install with <code>npx skills add modelstudioai/cli --all -g</code>'); return; }
1447+
if (!SKILLS.length) { pager.innerHTML = ''; renderEmpty(body, 'No skills installed.', 'Install with <code>bl skill add --name all</code>'); return; }
14481448
var list = SKILLS.filter(function (s) { return skillMatches(s, SKILL_Q); });
14491449
if (!list.length) { pager.innerHTML = ''; renderEmpty(body, 'No skills match "' + SKILL_Q + '".', ''); return; }
14501450
var info = pageSlice(list, SKILL_PAGE, getPageSize('skills')); SKILL_PAGE = info.page;

packages/commands/src/commands/update.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ import {
2020
type AnsiStyles,
2121
} from "bailian-cli-runtime";
2222

23-
const SKILL_SOURCE = "modelstudioai/cli";
24-
const SKILL_INSTALL_CMD = `npx skills add ${SKILL_SOURCE} --all -g -y`;
23+
const SKILL_INSTALL_CMD = "bl skill add --name all";
2524

2625
function updateAgentSkill(color: AnsiStyles): void {
2726
process.stderr.write("\nUpdating agent skill...\n");

0 commit comments

Comments
 (0)