Skip to content

Commit ca98d8a

Browse files
committed
refactor(skills): introduce bailian-protocol companion and slim bailian-cli routing
1 parent 1315885 commit ca98d8a

24 files changed

Lines changed: 226 additions & 165 deletions

File tree

.vite-hooks/pre-commit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pnpm run sync:skill-assets
66

77
# Stage generator output so it is included in this commit.
88
git add \
9-
skills/bailian-base/SKILL.md \
9+
skills/bailian-protocol/SKILL.md \
1010
skills/bailian-cli/SKILL.md \
1111
skills/bailian-cli/reference \
1212
skills/bailian-gen/SKILL.md \

AGENTS.md

Lines changed: 20 additions & 19 deletions
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` 安装。共享协议在 `skills/bailian-base/`;业务 skill(`bailian-cli` / `bailian-gen` / `bailian-finetune` / `bailian-managed-agent`)依赖它作为 companion。`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` 执行。
38+
Skill / 命令手册随 `skills/bailian-*/``npx skills add modelstudioai/cli` 安装。共享协议在 `skills/bailian-protocol/`;业务 skill(`bailian-cli` / `bailian-gen` / `bailian-finetune` / `bailian-managed-agent`)依赖它作为 companion。`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 文案 / companion / hand-off 约定见 [docs/agents/skill-change.md](docs/agents/skill-change.md)
3939

4040
约定:
4141

@@ -49,30 +49,31 @@ Skill / 命令手册随 `skills/bailian-*/` 经 `npx skills add modelstudioai/cl
4949

5050
- `tools/release/` — 发版自动化(CI 驱动,见 `.github/workflows/publish.yml`
5151
- `tools/generate-reference.ts` — 从 `packages/cli/src/commands.ts` 按归属表生成各 `skills/<skill>/reference/`
52-
- `tools/sync-skill-metadata.ts` — 同步各 `skills/*/SKILL.md``metadata.version`(含 `bailian-base`
52+
- `tools/sync-skill-metadata.ts` — 同步各 `skills/*/SKILL.md``metadata.version`(含 `bailian-protocol`
5353
- `README.md` / `README.zh.md` — npm 和 GitHub 主页
5454

5555
## 业务场景索引
5656

5757
按当前任务从下表挑一条进入对应文档:
5858

59-
| 场景 | 何时进入 | 详见 |
60-
| -------------- | -------------------------------------------- | ---------------------------------------------------------------------------- |
61-
| 命令增删改 | 增加 / 删除 / 重命名 `bl xxx` 或入口命令路径 | [docs/agents/command-add-remove.md](docs/agents/command-add-remove.md) |
62-
| E2E 测试维护 | 新增/改命令或 e2e 用例、补 help/缺参/dry-run | [docs/agents/cli-e2e-tests.md](docs/agents/cli-e2e-tests.md) |
63-
| 批量压测 | 改/跑多能力并发压测、`test:stress`、fixtures | [docs/agents/stress-batch-tests.md](docs/agents/stress-batch-tests.md) |
64-
| 选项变更 | 给已有命令加 `--flag` 或改默认值 | [docs/agents/command-flag-change.md](docs/agents/command-flag-change.md) |
65-
| 模型上下架 | 增加新模型 / 改默认模型 / 废弃旧模型 | [docs/agents/model-add-remove.md](docs/agents/model-add-remove.md) |
66-
| 错误文案变更 |`BailianError` 的 message 或 hint | [docs/agents/error-hint-change.md](docs/agents/error-hint-change.md) |
67-
| URL / 渠道变更 | 控制台域名 / 文档站 / 追踪参数 | [docs/agents/url-change.md](docs/agents/url-change.md) |
68-
| 鉴权扩展 | 加 OAuth / SSO / 换 token 来源 | [docs/agents/auth-change.md](docs/agents/auth-change.md) |
69-
| 配置项扩展 | 新 env var 或 `~/.bailian/config.json` 字段 | [docs/agents/config-add.md](docs/agents/config-add.md) |
70-
| Profile / 激活 | 改命名 Profile、预设或 `active_config` | [docs/agents/config-profile-change.md](docs/agents/config-profile-change.md) |
71-
| 安装文档 | 改安装、鉴权、验证流程或线上 install 页面 | [docs/agents/install-doc-change.md](docs/agents/install-doc-change.md) |
72-
| 发布 | channel / stable 发布到 npm(CI 驱动) | [docs/agents/publish.md](docs/agents/publish.md) |
73-
| Change Log | 发版说明 / 历史版本说明 | [docs/agents/changelog-write.md](docs/agents/changelog-write.md) |
74-
| 工具链调整 | lint 规则 / 构建配置 / 依赖升级 | [docs/agents/lint-toolchain.md](docs/agents/lint-toolchain.md) |
75-
| Command Pack | 扩展包 / 白名单 / plugin 管理命令 | [docs/agents/command-pack.md](docs/agents/command-pack.md) |
59+
| 场景 | 何时进入 | 详见 |
60+
| ----------------- | ------------------------------------------------ | ---------------------------------------------------------------------------- |
61+
| 命令增删改 | 增加 / 删除 / 重命名 `bl xxx` 或入口命令路径 | [docs/agents/command-add-remove.md](docs/agents/command-add-remove.md) |
62+
| E2E 测试维护 | 新增/改命令或 e2e 用例、补 help/缺参/dry-run | [docs/agents/cli-e2e-tests.md](docs/agents/cli-e2e-tests.md) |
63+
| 批量压测 | 改/跑多能力并发压测、`test:stress`、fixtures | [docs/agents/stress-batch-tests.md](docs/agents/stress-batch-tests.md) |
64+
| 选项变更 | 给已有命令加 `--flag` 或改默认值 | [docs/agents/command-flag-change.md](docs/agents/command-flag-change.md) |
65+
| 模型上下架 | 增加新模型 / 改默认模型 / 废弃旧模型 | [docs/agents/model-add-remove.md](docs/agents/model-add-remove.md) |
66+
| Skill 文案 / 路由 | 改 SKILL 路由、companion、hand-off、hub/领域边界 | [docs/agents/skill-change.md](docs/agents/skill-change.md) |
67+
| 错误文案变更 |`BailianError` 的 message 或 hint | [docs/agents/error-hint-change.md](docs/agents/error-hint-change.md) |
68+
| URL / 渠道变更 | 控制台域名 / 文档站 / 追踪参数 | [docs/agents/url-change.md](docs/agents/url-change.md) |
69+
| 鉴权扩展 | 加 OAuth / SSO / 换 token 来源 | [docs/agents/auth-change.md](docs/agents/auth-change.md) |
70+
| 配置项扩展 | 新 env var 或 `~/.bailian/config.json` 字段 | [docs/agents/config-add.md](docs/agents/config-add.md) |
71+
| Profile / 激活 | 改命名 Profile、预设或 `active_config` | [docs/agents/config-profile-change.md](docs/agents/config-profile-change.md) |
72+
| 安装文档 | 改安装、鉴权、验证流程或线上 install 页面 | [docs/agents/install-doc-change.md](docs/agents/install-doc-change.md) |
73+
| 发布 | channel / stable 发布到 npm(CI 驱动) | [docs/agents/publish.md](docs/agents/publish.md) |
74+
| Change Log | 发版说明 / 历史版本说明 | [docs/agents/changelog-write.md](docs/agents/changelog-write.md) |
75+
| 工具链调整 | lint 规则 / 构建配置 / 依赖升级 | [docs/agents/lint-toolchain.md](docs/agents/lint-toolchain.md) |
76+
| Command Pack | 扩展包 / 白名单 / plugin 管理命令 | [docs/agents/command-pack.md](docs/agents/command-pack.md) |
7677

7778
如果当前任务无法对应任何场景,先按经验完成,然后**回来评估这是不是一类新场景** —— 是就新增 `docs/agents/<scenario>.md`,把清单沉淀下来。
7879

INSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ CLI 校验通过后,在本机终端执行:
5353
npx skills add modelstudioai/cli --all -g
5454
```
5555

56-
推荐 `--all`(含 companion `bailian-base`)。若只装单个业务 skill,必须同时带上 `bailian-base`,例如:
56+
推荐 `--all`(含 companion `bailian-protocol`)。若只装单个业务 skill,必须同时带上 `bailian-protocol`,例如:
5757

5858
```bash
59-
npx skills add modelstudioai/cli -g -s bailian-base -s bailian-gen
59+
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-gen
6060
```
6161

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

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ No timeline scrubbing. No frame-by-frame editing. Just one sentence → one vide
7878

7979
```bash
8080
npm install -g bailian-cli
81-
# Recommended: full bailian-* skill family (includes companion bailian-base)
81+
# Recommended: full bailian-* skill family (includes companion bailian-protocol)
8282
npx skills add modelstudioai/cli --all -g
8383
```
8484

85-
Subset install — always include companion `bailian-base` with any business skill:
85+
Subset install — always include companion `bailian-protocol` with any business skill:
8686

8787
```bash
88-
npx skills add modelstudioai/cli -g -s bailian-base -s bailian-gen
89-
npx skills add modelstudioai/cli -g -s bailian-base -s bailian-cli
88+
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-gen
89+
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-cli
9090
```
9191

9292
> Requires Node.js >= 18.17.

README.zh.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ _专为 AI Agent 打造,每个命令均可作为结构化工具调用。_
7676

7777
```bash
7878
npm install -g bailian-cli
79-
# 推荐:安装完整 bailian-* skill 家族(含 companion bailian-base
79+
# 推荐:安装完整 bailian-* skill 家族(含 companion bailian-protocol
8080
npx skills add modelstudioai/cli --all -g
8181
```
8282

83-
子集安装时,业务 skill 必须同时带上 companion `bailian-base`
83+
子集安装时,业务 skill 必须同时带上 companion `bailian-protocol`
8484

8585
```bash
86-
npx skills add modelstudioai/cli -g -s bailian-base -s bailian-gen
87-
npx skills add modelstudioai/cli -g -s bailian-base -s bailian-cli
86+
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-gen
87+
npx skills add modelstudioai/cli -g -s bailian-protocol -s bailian-cli
8888
```
8989

9090
> 需要预先安装 Node.js >= 18.17。

docs/agents/command-add-remove.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ packages/commands/src/index.ts
9090
- [ ] 运行 `pnpm run sync:skill-assets`(或正常 `git commit` 走 pre-commit),刷新各 `skills/<skill>/reference/``SKILL.md``metadata.version` 并提交
9191
- [ ] `README.md` / `README.zh.md`:Quick Start、命令一览、认证说明(用户向,与 help 对齐)
9292
- [ ] 相关 `skills/<skill>/SKILL.md`:若安装说明或能力边界有变,同步更新;新一级命令组若属领域 skill,同步改 `tools/generate-reference.ts``GROUP_OWNER_SKILL`
93+
- [ ] **拥有方** skill 的「When to use which command」(或等价路由表)补上新意图;hub `bailian-cli` 仅加/改 hand-off 行,**不要**把领域子命令与默认模型抄进 hub 表(约定见 [skill-change.md](skill-change.md))
9394

9495
### D. 测试层
9596

@@ -129,6 +130,7 @@ pnpm -F knowledge-studio-cli exec tsx src/main.ts <command> --help
129130
- ✗ 只导出了命令实现,忘了在 `packages/cli/src/commands.ts` 暴露路径 → `bl --help` 看不到
130131
- ✗ 手改 `skills/*/reference/*.md` → 下次 generate 被覆盖;应改 command metadata 后重新 generate 并提交
131132
- ✗ 新一级命令组忘改 `tools/generate-reference.ts``GROUP_OWNER_SKILL` → reference 会落到 hub `bailian-cli`(未必是预期)
133+
- ✗ 只改 reference / hub,忘改拥有方 skill 路由表;或把领域命令明细重新抄回 `bailian-cli` SKILL → 与 [skill-change.md](skill-change.md) 分层冲突
132134
- ✗ 在 `usageArgs` / `exampleArgs` 写死 `bl text chat``kscli` 等入口复用时 help 错
133135
- ✗ Console Gateway 命令忘设 `auth: "console"` → console flags / credential 注入都不生效
134136
- ✗ 单 action 的子组是反模式,新增时优先拍平为两级

docs/agents/model-add-remove.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
### C. 命令手册
2828

2929
- [ ]`--model` 的 description 含 default,改命令后跑 `pnpm --filter bailian-cli run generate:reference` 更新对应 `skills/<skill>/reference/<group>.md` 并提交
30+
- [ ] 同步**拥有该命令的领域 skill**「When to use which command」表中的 Default model(现主要是 `bailian-gen`;精调相关看 `bailian-finetune` 正文示例)。hub `bailian-cli` 已瘦身,一般**不必**再写领域默认模型(见 [skill-change.md](skill-change.md))
3031

3132
### D. 用户面文档
3233

@@ -49,6 +50,7 @@ pnpm -F bailian-cli exec tsx src/main.ts <command> --model <new-model> --message
4950

5051
## 常见漏点
5152

52-
- ✗ 改了命令默认模型,但 SKILL.md frontmatter 仍写老型号 → AI agent 调用时仍按老型号宣传
53+
- ✗ 改了命令默认模型,但 SKILL.md frontmatter 或领域路由表 Default model 仍写老型号 → AI agent 调用时仍按老型号宣传
54+
- ✗ 只改了 `reference/` / flag description,忘改 `bailian-gen`(等) SKILL 路由表
5355
- ✗ 废弃模型时只删了代码,e2e 测试还在跑,CI 红
5456
- ✗ 新模型 endpoint 不一致,但只改了 default,没加 endpoint 分支判断

docs/agents/publish.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@
3737

3838
两种模式都会先跑 `check.mjs`,覆盖以下检查:
3939

40-
| 检查项 | 说明 |
41-
| -------------------------------- | ----------------------------------------------------------------------------------------------------------- |
42-
| `pnpm install --frozen-lockfile` | lockfile 一致性 |
43-
| README 同步 | `packages/cli/README.md` 与根 README 一致 |
44-
| 版本号一致 | `tools/release/lib/packages.mjs` 中待发布包集合 version 相同 |
45-
| `workspace:*` 替换 | 发布包间 workspace 依赖解析为真实版本号 |
46-
| 构建 | 基础发布构建 core/runtime/commands 依赖和 cli;`--knowledge` 额外构建 `knowledge-studio-cli` |
47-
| 生成资产 | 重建各 `skills/<skill>/reference/`;非 channel 模式还同步各 `skills/*/SKILL.md` version(含 `bailian-base`|
48-
| pnpm pack | 打 tarball |
49-
| publint | 包元数据校验 |
50-
| gitleaks | 敏感信息扫描 |
40+
| 检查项 | 说明 |
41+
| -------------------------------- | --------------------------------------------------------------------------------------------------------------- |
42+
| `pnpm install --frozen-lockfile` | lockfile 一致性 |
43+
| README 同步 | `packages/cli/README.md` 与根 README 一致 |
44+
| 版本号一致 | `tools/release/lib/packages.mjs` 中待发布包集合 version 相同 |
45+
| `workspace:*` 替换 | 发布包间 workspace 依赖解析为真实版本号 |
46+
| 构建 | 基础发布构建 core/runtime/commands 依赖和 cli;`--knowledge` 额外构建 `knowledge-studio-cli` |
47+
| 生成资产 | 重建各 `skills/<skill>/reference/`;非 channel 模式还同步各 `skills/*/SKILL.md` version(含 `bailian-protocol`|
48+
| pnpm pack | 打 tarball |
49+
| publint | 包元数据校验 |
50+
| gitleaks | 敏感信息扫描 |
5151

5252
本地可以 dry-run 验证:
5353

0 commit comments

Comments
 (0)