Skip to content

Commit a393bdc

Browse files
committed
refactor(kb-dsh): 删除已过期的 reference/*.md,参数详情交还 --help
插件不是 CLI,没有义务维护一份 bl 参数手册。已有的 8 个 reference 文件锚死在 bailian-cli 1.16.0:--description 改为必填后(1.17.1)它就在教一条必然失败的命令。 SKILL.md 备注列改为引导 agent 跑 `bl <命令> --help`(与其自身前置检查第 1 步 一致);核心示例补 --description;命令参考段从死链改为纯指引。 docs/agents/dsh-plugin.md D 项同步更新:不带 reference/,不由生成器产出。
1 parent d24104f commit a393bdc

10 files changed

Lines changed: 15 additions & 936 deletions

File tree

docs/agents/dsh-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
### D. skill 资产
5656

5757
- [ ] `skills/bailian-kb/` 留在**包内**,不要挪到仓库顶层 `skills/``.github/workflows/publish-skills.yml``skills/**` 全量对账到 OSS registry,`bl skill init` 会装给所有 `bl` 用户,而这个 skill 讲的 `kb_search` / `kb_chat` 原生工具只在 dsh 里存在
58-
- [ ] `SKILL.md` 手写(承载"检索走原生工具、管理走 `bl`"的路由决策);`reference/` `tools/generate-reference.ts` 生成,不要手改
58+
- [ ] skill 只有一个手写 `SKILL.md`**不带 `reference/`**:它不是 CLI,没有义务维护一份 `bl` 参数手册。`bl` 命令的 flag 详情交给 `bl <命令> --help`(权威的 `bl` reference `tools/generate-reference.ts` 写到 `skills/bailian-cli/reference/`,与本包无关)。SKILL.md 里写到的 `bl` 命令/flag 修改时手动核对 `packages/commands/src/commands/`,不要锚版本号
5959

6060
### E. 依赖与测试约定
6161

packages/bailian-kb-dsh/skills/bailian-kb/SKILL.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,23 @@ description: >-
3434

3535
## 何时用哪个命令
3636

37-
| 用户意图 | 命令 | 备注 |
38-
| ---------------------------------------- | --------------------------------------------------- | -------------------------------------------------- |
39-
| 查知识 / 问答(日常检索) | 原生工具 `kb_search` / `kb_chat` | 不走 bl |
40-
| 建库 / 查看 / 改名 / 删库 / 监控 | `bl knowledge create/list/info/update/delete/stats` | [reference/kb.md](reference/kb.md) |
41-
| 上传本地文档、看解析状态、删文档、打标签 | `bl knowledge doc upload/list/status/delete/tag` | [reference/doc.md](reference/doc.md) |
42-
| 从 OSS 批量导入 | `bl knowledge doc import-oss` | Bucket 需预先授权服务角色 |
43-
| 创建 / 部署 / 调参检索(问答)服务 | `bl knowledge service create/update/deploy/…` | [reference/service.md](reference/service.md) |
44-
| 修正错误切片、屏蔽某段内容 | `bl knowledge chunk add/list/update/delete` | [reference/chunk.md](reference/chunk.md) |
45-
| 数据中心类目 / 文件 / 集合管理 | `bl knowledge category/file/collection …` | [reference/datacenter.md](reference/datacenter.md) |
46-
| CLI 配置、升级 | `bl config show/set``bl update` | [reference/config.md](reference/config.md) |
47-
| 部署后验证、调试草稿版服务 | `bl knowledge search/chat --agent-version beta` | [reference/query.md](reference/query.md) |
37+
| 用户意图 | 命令 | 备注 |
38+
| ---------------------------------------- | --------------------------------------------------- | -------------------------------- |
39+
| 查知识 / 问答(日常检索) | 原生工具 `kb_search` / `kb_chat` | 不走 bl |
40+
| 建库 / 查看 / 改名 / 删库 / 监控 | `bl knowledge create/list/info/update/delete/stats` | `bl knowledge create --help` |
41+
| 上传本地文档、看解析状态、删文档、打标签 | `bl knowledge doc upload/list/status/delete/tag` | `bl knowledge doc upload --help` |
42+
| 从 OSS 批量导入 | `bl knowledge doc import-oss` | Bucket 需预先授权服务角色 |
43+
| 创建 / 部署 / 调参检索(问答)服务 | `bl knowledge service create/update/deploy/…` | `bl knowledge service --help` |
44+
| 修正错误切片、屏蔽某段内容 | `bl knowledge chunk add/list/update/delete` | `bl knowledge chunk --help` |
45+
| 数据中心类目 / 文件 / 集合管理 | `bl knowledge category/file/collection …` | `bl knowledge category --help` |
46+
| CLI 配置、升级 | `bl config show/set``bl update` | `bl config --help` |
47+
| 部署后验证、调试草稿版服务 | `bl knowledge search/chat --agent-version beta` | `bl knowledge search --help` |
4848

4949
## 核心工作流:建库到可检索
5050

5151
```bash
5252
bl knowledge doc upload --file ./docs/ --workspace-id ws-xxx # 1. 上传本地文件/目录 → 得 fileId
53-
bl knowledge create --name my-kb --doc-id <fileId> --wait # 2. 建库并导入 → 得 index-id (pipelineId)
53+
bl knowledge create --name my-kb --description '产品文档' --doc-id <fileId> --wait # 2. 建库并导入 → 得 index-id (pipelineId)
5454
bl knowledge service create --name my-search --scene search --index-id <index-id> # 3. 建检索服务 → 得 agent-id(draft)
5555
bl knowledge service deploy --agent-id <agent-id> --yes # 4. 发布服务(此后可被默认版本调用)
5656
bl knowledge service list --scene search --status deployed # 5. 确认服务可见
@@ -71,14 +71,9 @@ bl knowledge service list --scene search --status deployed # 5.
7171
| chunk id | `chunk list` 输出的 `metadata._id` | `chunk update/delete``--chunk-id` |
7272
| `agent-id` | `service create/list` | `service *``kb_search`/`kb_chat``bl knowledge search/chat` |
7373

74-
## 命令参考(权威)
74+
## 命令参考
7575

76-
命令的完整 Usage / Flags / Notes / Examples 在 [`reference/`](reference/index.md)
77-
78-
- [reference/index.md](reference/index.md) — 全命令速查表、全局 flag、鉴权说明
79-
- reference/&lt;group&gt;.md — 按命令组分文件(kb / doc / service / chunk / datacenter / config / query)
80-
81-
执行不熟悉的命令前,先读对应 reference 或跑 `bl <命令> --help`**不要猜 flag。**
76+
执行不熟悉的命令前,跑 `bl <命令> --help` 查看完整 Usage / Flags / Notes / Examples。**不要猜 flag。**
8277
全部命令支持 `--output json`(结构化输出)、`--dry-run`(预览请求)、`--quiet``--verbose`
8378

8479
## 危险与不可逆操作

packages/bailian-kb-dsh/skills/bailian-kb/reference/chunk.md

Lines changed: 0 additions & 100 deletions
This file was deleted.

packages/bailian-kb-dsh/skills/bailian-kb/reference/config.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

packages/bailian-kb-dsh/skills/bailian-kb/reference/datacenter.md

Lines changed: 0 additions & 158 deletions
This file was deleted.

0 commit comments

Comments
 (0)