bailian-cli — AI 维护指南

本文件是 AI agent 维护本仓库时的契约。每次进入项目先读这里,从"业务场景索引"挑一条,再进入对应 docs/agents/*.md 清单。

项目地图

monorepo 现在按"纯逻辑 → 运行时框架 → 命令库 → 产品入口"分层:

• packages/core — bailian-cli-core,纯逻辑层:鉴权、配置、HTTP client、错误、类型、文件工具
• packages/runtime — bailian-cli-runtime,通用 CLI 运行时:createCli、参数解析、registry/help、middleware、error handler、输出、pipeline、Command Pack host
• packages/commands — bailian-cli-commands,可复用命令实现库,只导出 command,不决定产品路径
• packages/cli — bailian-cli,完整 bl 产品入口;src/commands.ts 组装 bl 暴露的命令路径
• packages/kscli — knowledge-studio-cli,Knowledge Studio 专用入口;src/main.ts 复用 commands 并重映射为 kscli 路径
• packages/bailian-kb-dsh — bailian-kb-dsh,下游宿主适配层(依赖方向朝外):百炼知识库的 DeepSeek Harness (dsh) 插件,消费 bl CLI 与知识库 API,不在上面这条分层链上;构建独立，版本与发布跟随 bailian-cli,见 docs/agents/dsh-plugin.md
• packages/bailian-memo-dsh — bailian-memo-dsh,下游宿主适配层:百炼个人记忆 dsh 插件(dsh 0.2.1 Volatile Config / SettingsForms);身份在 ~/.bailian/personal-memory/config.json;构建独立，版本与发布跟随 bailian-cli,见 docs/agents/dsh-plugin.md

关键文件

packages/cli/src/main.ts          # bl 入口,注入 binName/version/clientName/npmPackage
packages/cli/src/commands.ts      # bl 产品命令 map,tools/generate-reference.ts 也读它
packages/cli/src/command-pack-policy.ts # bl 的 Command Pack policy
packages/kscli/src/main.ts        # kscli 入口和命令 map

packages/commands/src/index.ts    # re-export 单个命令实现
packages/commands/src/commands/   # defineCommand({ auth, flags, usageArgs, exampleArgs, run })

packages/runtime/src/create-cli.ts # createCli(commands, options)
packages/runtime/src/registry.ts   # 命令树解析 + 动态 help
packages/runtime/src/middleware.ts # auth / telemetry / update / run command
packages/runtime/src/command-packs/ # 通用 Command Pack 加载、校验、隔离安装目录和管理命令
packages/runtime/src/urls.ts       # 用户面控制台 URL

packages/core/src/types/command.ts # Command / flags / auth 类型
packages/core/src/config/          # ConfigFile / Settings / source 解析
packages/core/src/auth/            # apiKey / console credential 解析与落盘
packages/core/src/client/          # HTTP client / endpoints / console gateway

Skill / 命令手册随 skills/bailian-*/ 经 bl skill init 安装（装齐 registry 中全部 bailian-*，含共享协议 bailian-protocol）。业务 skill（bailian-cli / bailian-gen / bailian-finetune / bailian-managed-agent / bailian-sandbox / bailian-web-search）执行前读 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。

约定:

• 命令实现文件路径仍按能力放置:packages/commands/src/commands/text/chat.ts
• 产品命令路径由入口 map 决定:同一个实现可暴露为 bl knowledge search 或 kscli search
• defineCommand 只写命令元数据与逻辑: auth、flags、usageArgs、exampleArgs、validate、run
• usageArgs / exampleArgs 不写 bl 或 kscli 前缀;runtime / reference 生成器按产品路径补前缀
• 不再使用 catalog.ts 作为登记处;新增/重命名命令必须同时看命令库导出和产品入口 map

非代码资产:

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

业务场景索引

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

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

通用约定

1. 发布包版本号同步

源码包的 version 当前保持一致: packages/core、packages/runtime、packages/commands、packages/cli、packages/kscli、packages/bailian-kb-dsh、packages/bailian-memo-dsh。做版本 bump 时一动多动。release 工具当前强校验 / 发布范围以 tools/release/lib/packages.mjs 为准;把新包纳入发布前必须同步该清单和 publish.md。

两个 dsh 插件也纳入七包锁步版本和统一发布，仅构建方式保留各自的 tsc / tsdown。

2. 分层边界

• core 是纯库:不依赖 runtime / commands / 产品入口;不调 process.exit;新增/改动时不硬编码 bl / kscli 命令名、控制台 URL 或渠道追踪参数。当前遗留项见 error-hint-change.md 与 url-change.md,触碰相关代码时顺手收敛
• runtime 是通用 CLI 框架:可以处理 TTY、help、错误输出、middleware,但不写具体业务命令逻辑
• commands 是命令实现库:不决定产品路径;不在 usageArgs / exampleArgs / hint 里硬编码产品 bin 前缀
• cli / kscli 是产品层:负责命令路径 map、产品 identity、README、技能 reference、发版入口
• bailian-kb-dsh / bailian-memo-dsh 在这条链之外:它们是别的宿主(dsh)里的插件,刻意不依赖本仓 core/runtime/commands(自包含 endpoints/client);反过来产品层永远不许依赖它们
• URL 集中在 packages/runtime/src/urls.ts(用户面控制台)和 packages/core/src/config/schema.ts / client 层(API)

3. 错误处理边界:CLI 不翻译服务端错误

CLI 只为「自己能权威解释的错误」发出语义化信号,服务端的错误原样透传。详见 docs/agents/error-hint-change.md。

不要扮演服务端错误的翻译官——我们没有最新的错误码体系认知,二次包装只会撒谎。

4. Console Gateway 命令必须声明鉴权域

如果命令调用 Console Gateway,defineCommand 必须设置 auth: "console"。runtime 会基于 CONSOLE_AUTH_FLAGS 自动在 help 中展示 --console-region、--console-site、--console-switch-agent、--workspace-id,并由 authStage 解析/注入 console credential。命令不要重复声明这些凭证域 flag,也不要手动从 env/config 解析 token。

5. 禁止单字母变量命名

所有变量、参数、回调形参必须使用有语义的命名,不允许单字母(如 i、m、p、t、e、s)。具体表现:

• 回调参数: .map((m) => ...) → .map((model) => ...), .find((t) => ...) → .find((template) => ...)
• catch 变量: catch (e) → catch (error)
• for-of 循环: for (const i of items) → for (const item of items)
• 临时变量: const s = ... → const strategy = ...

例外: 仅当作用域极小(≤3 行)且语义从上下文完全明确时,可使用 k/v(Object.entries 的 key/value)。

6. 用户可见 CLI 文案必须支持中英文

新增或修改用户可见的 CLI 文案时必须同时提供 en-US / zh-CN;runtime 公共文案遵循同一规则,服务端错误仍按第 3 节原样透传。命令文案的具体检查项见 command-add-remove.md。

完成改动后的快速验证

新增或修改任何 **/tests/** 用例（含 tests/output）前，必须读取测试维护规范。测试通过之外，还必须检查执行成本：按测试目标选择执行层，说明必要的子进程覆盖，并对新增/扩展套件提供耗时记录；性能优化必须提供同条件前后对比，不能靠删除必要覆盖或增加跳过项提速。具体执行方式、隔离与验收清单统一在该文档维护。

vp check    # format + lint + type check
vp test     # unit + e2e (真实集成需 API key / console token)

这份指南本身怎么演化

这套文档不是写完就死,随真实工作沉淀。完成每次改动后回看:这次发现的漏点该不该补?是不是一类新场景?

新增场景 / 改主入口 / 跨文档引用规则 → docs/agents/maintaining-agent-docs.md