diff --git a/AGENTS.md b/AGENTS.md index d26a7a51..474d901e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -68,6 +68,7 @@ Skill / 命令手册随 `skills/bailian-cli/` 经 `npx skills add modelstudioai/ | 鉴权扩展 | 加 OAuth / SSO / 换 token 来源 | [docs/agents/auth-change.md](docs/agents/auth-change.md) | | 配置项扩展 | 新 env var 或 `~/.bailian/config.json` 字段 | [docs/agents/config-add.md](docs/agents/config-add.md) | | Profile / 激活 | 改命名 Profile、预设或 `active_config` | [docs/agents/config-profile-change.md](docs/agents/config-profile-change.md) | +| 安装文档 | 改安装、鉴权、验证流程或线上 install 页面 | [docs/agents/install-doc-change.md](docs/agents/install-doc-change.md) | | 发布 | channel / stable 发布到 npm(CI 驱动) | [docs/agents/publish.md](docs/agents/publish.md) | | Change Log | 发版说明 / 历史版本说明 | [docs/agents/changelog-write.md](docs/agents/changelog-write.md) | | 工具链调整 | lint 规则 / 构建配置 / 依赖升级 | [docs/agents/lint-toolchain.md](docs/agents/lint-toolchain.md) | diff --git a/INSTALL.md b/INSTALL.md index 7e31ec61..27a7e151 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -98,7 +98,7 @@ npx skills add modelstudioai/cli --all -g ### Agent 安全约束 - **禁止**把真实 API Key 写入仓库、日志、Skill、聊天记录的可公开部分。 -- CI / 非交互环境:使用 `bl ... --non-interactive`;通过密钥管理或环境变量注入,勿在脚本中硬编码 Key。 +- CI / 非交互环境:显式传入必填参数并使用 `--output json` 获取机器可读结果;如需纯文本输出,设置 `NO_COLOR=1`。通过密钥管理或环境变量注入,勿在脚本中硬编码 Key。 --- diff --git a/docs/agents/install-doc-change.md b/docs/agents/install-doc-change.md new file mode 100644 index 00000000..accbb508 --- /dev/null +++ b/docs/agents/install-doc-change.md @@ -0,0 +1,42 @@ +# 安装文档变更 + +## 触发条件 + +- 修改根目录 `INSTALL.md` 的安装、鉴权或验证流程 +- 修改发布包 Node.js 要求、全局 flag 或安装文档引用的命令 +- 同步或发布 `https://bailian.aliyun.com/cli/install.md` + +## 必查清单 + +### A. CLI 契约 + +- [ ] `INSTALL.md` 中的 `bl` 命令路径存在于 `packages/cli/src/commands.ts` +- [ ] 示例 flag 属于 `GLOBAL_FLAGS`、命令鉴权域 flag 或命令自身 `flags` +- [ ] Node.js 用户安装要求与 `packages/cli/package.json` 的 `engines.node` 一致,不使用根 `package.json` 的开发环境要求 +- [ ] 鉴权流程与 `packages/commands/src/commands/auth/` 的实际校验、保存和 Profile 激活行为一致 + +### B. 静态副本 + +- [ ] 将 `INSTALL.md` 同步到 `bailian-cli-static-resources/public/install.txt` +- [ ] 使用 `cmp -s` 确认两份文档逐字节一致 +- [ ] 静态资源仓库单独创建分支、提交和发布,不把跨仓库改动遗漏在 CLI PR 之外 + +### C. 线上验证 + +- [ ] 发布后读取 `https://bailian.aliyun.com/cli/install.md`,确认内容来自最新静态副本 +- [ ] 带随机 query 参数复查,区分 CDN 缓存与源站未更新 +- [ ] 验证线上文档中的安装命令、Node.js 要求和配置验证段落,不只检查页面可访问 + +## 完成后自查 + +```sh +pnpm -F bailian-cli test -- tests/install-doc.test.ts +cmp -s INSTALL.md ../bailian-cli-static-resources/public/install.txt +curl -L -s "https://bailian.aliyun.com/cli/install.md?verify=$(date +%s)" +``` + +## 常见漏点 + +- `--non-interactive` 已从 CLI 移除,但旧安装文档和静态副本仍把它当作全局 flag +- 根 `package.json` 是开发工具链 Node.js 要求;用户安装要求以 `packages/cli/package.json` 为准 +- 静态仓库文件名是 `public/install.txt`,线上稳定地址是 `/cli/install.md`;只更新其中一侧不会自动证明发布成功 diff --git a/packages/cli/tests/install-doc.test.ts b/packages/cli/tests/install-doc.test.ts new file mode 100644 index 00000000..7988a6ad --- /dev/null +++ b/packages/cli/tests/install-doc.test.ts @@ -0,0 +1,73 @@ +import { readFileSync } from "node:fs"; +import { join } from "node:path"; +import { credentialFlagDefs, GLOBAL_FLAGS, type AnyCommand } from "bailian-cli-core"; +import { monorepoRoot } from "e2e/monorepo-root"; +import { describe, expect, test } from "vite-plus/test"; +import { commands } from "../src/commands.ts"; + +const repositoryRoot = monorepoRoot(); +const installGuide = readFileSync(join(repositoryRoot, "INSTALL.md"), "utf8"); +const cliPackage = JSON.parse( + readFileSync(join(repositoryRoot, "packages/cli/package.json"), "utf8"), +) as { + engines?: { node?: string }; +}; + +function toFlagName(key: string): string { + return `--${key.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`)}`; +} + +function findDocumentedCommand(snippet: string): { + commandPath?: string; + command?: AnyCommand; +} { + const argumentText = snippet.slice("bl ".length).trim(); + const commandPath = Object.keys(commands) + .sort((leftPath, rightPath) => rightPath.length - leftPath.length) + .find((candidatePath) => { + return argumentText === candidatePath || argumentText.startsWith(`${candidatePath} `); + }); + + return commandPath ? { commandPath, command: commands[commandPath] } : {}; +} + +function documentedCommandSnippets(): string[] { + const fencedCommands = installGuide + .split("\n") + .map((line) => line.trim()) + .filter((line) => line.startsWith("bl ")); + const inlineCommands = Array.from(installGuide.matchAll(/`(bl [^`\n]+)`/g), (match) => match[1]); + return [...new Set([...fencedCommands, ...inlineCommands])]; +} + +describe("INSTALL.md", () => { + test("发布包 Node.js 要求与安装文档一致", () => { + const nodeEngine = cliPackage.engines?.node; + expect(nodeEngine).toMatch(/^>=\d+\.\d+\.\d+$/); + expect(installGuide).toContain(`要求 **≥ ${nodeEngine?.slice(2)}**`); + }); + + test("示例只使用当前命令支持的 flags", () => { + for (const snippet of documentedCommandSnippets()) { + const { commandPath, command } = findDocumentedCommand(snippet); + const argumentText = snippet.slice("bl ".length).trim(); + + if (!commandPath || !command) { + expect(argumentText, `INSTALL.md 中存在未知命令:${snippet}`).toMatch(/^--/); + } + + const supportedFlags = { + ...GLOBAL_FLAGS, + ...(command ? credentialFlagDefs(command) : {}), + ...command?.flags, + }; + const supportedFlagNames = new Set(Object.keys(supportedFlags).map(toFlagName)); + const usedFlagNames = Array.from(snippet.matchAll(/--[a-z0-9-]+/g), (match) => match[0]); + const unsupportedFlagNames = usedFlagNames.filter( + (flagName) => !supportedFlagNames.has(flagName), + ); + + expect(unsupportedFlagNames, `INSTALL.md 命令使用了未声明的 flag:${snippet}`).toEqual([]); + } + }); +});