diff --git a/AGENTS.md b/AGENTS.md index 1c40a64..51afe94 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -32,7 +32,7 @@ Skill / 命令手册随 `skills/bailian-cli/` 经 `npx skills add modelstudioai/ - `tools/release/` — 发版自动化（CI 驱动，见 `.github/workflows/publish.yml`） - `tools/generate-reference.ts` — 从 `catalog.ts` 生成命令手册到 `skills/bailian-cli/reference/` - `tools/sync-skill-metadata.ts` — 从 `packages/cli/package.json` 同步 `skills/bailian-cli/SKILL.md` 的 `metadata.version`（与 `generate:reference` 一并由根目录 `pnpm run sync:skill-assets` 及 pre-commit 执行） -- `README.md` / `README_CN.md` — npm 和 GitHub 主页 +- `README.md` / `README.zh.md` — npm 和 GitHub 主页 约定: diff --git a/CONTRIBUTING_CN.md b/CONTRIBUTING_CN.md index 16c9f2c..257c42c 100644 --- a/CONTRIBUTING_CN.md +++ b/CONTRIBUTING_CN.md @@ -1,8 +1,8 @@ # 参与贡献 bailian-cli -`bailian-cli` 是阿里云百炼(DashScope)的官方 CLI。本文是面向**开发者**的指南;终端用户请看 [README_CN.md](README_CN.md)。 +`bailian-cli` 是阿里云百炼(DashScope)的官方 CLI。本文是面向**开发者**的指南;终端用户请看 [README.zh.md](README.zh.md)。 -[English](CONTRIBUTING.md) · [README](README_CN.md) · [更新日志](CHANGELOG_CN.md) +[English](CONTRIBUTING.md) · [README](README.zh.md) · [更新日志](CHANGELOG_CN.md) ## 环境要求 diff --git a/README.md b/README.md index 790bf78..52eae74 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6)](https://www.typescriptlang.org) [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE) -[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README_CN.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&) +[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README.zh.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&) --- diff --git a/README_CN.md b/README.zh.md similarity index 100% rename from README_CN.md rename to README.zh.md diff --git a/docs/agents/auth-change.md b/docs/agents/auth-change.md index 349047e..d84ba5b 100644 --- a/docs/agents/auth-change.md +++ b/docs/agents/auth-change.md @@ -89,7 +89,7 @@ flag 优先 ─→ config 文件 ─→ env var ### F. 用户面文档 -- [ ] `README.md` / `README_CN.md` "Authentication" 段落 +- [ ] `README.md` / `README.zh.md` "Authentication" 段落 ### G. 测试 diff --git a/docs/agents/branch-merge-review.md b/docs/agents/branch-merge-review.md index de20765..be5667e 100644 --- a/docs/agents/branch-merge-review.md +++ b/docs/agents/branch-merge-review.md @@ -55,7 +55,7 @@ git diff --name-only ... ## 清单 B:用户透出(用户可见的新东西必看) - [ ] **新命令 / 新 flag** 已同步到用户面文档: - - [README.md](README.md) + [README_CN.md](README_CN.md)(中英文都要,常漏 `_CN`) + - [README.md](README.md) + [README.zh.md](README.zh.md)(中英文都要,常漏 `_CN`) - (SKILL.md 已迁出本仓库,由 `npx add skills` 机制独立维护,不在本仓库 review 范围) - [ ] **`bl --help`** 文案完整:`description` / `examples` / `apiDocs` 都填了 - [ ] **demo / quickstart**:用户可调用的新命令至少有一个示例 @@ -67,7 +67,7 @@ git diff --name-only ... - [ ] **改了文件但没补测试**:`git diff --stat ... -- '*test*' '*spec*'` 与改动文件清单对照 - [ ] **新功能埋点同步**:遥测事件名 + 参数 allowlist(参考 main 上的 `feat(telemetry): track console gateway api name in params allowlist` commit) - [ ] **环境变量**:新增 / 重命名的 env var 进 README,旧的有没有兼容 -- [ ] **i18n**:`README.md` 改了,`README_CN.md` 同步了吗 +- [ ] **i18n**:`README.md` 改了,`README.zh.md` 同步了吗 ## 输出报告(照模板填) @@ -98,7 +98,7 @@ git diff --name-only ... | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------- | | `pnpm-workspace.yaml` 把 `packages/*` 收窄成显式列表 | 合并后目标分支的新子包不再被 workspace 识别,`pnpm install` 看似正常但子包失联 | | 源分支 version 比目标分支低,直接 merge 覆盖 | npm 上版本号回退,latest tag 错乱 | -| `registry.ts` 注册新命令但忘了 [README](README.md) / [README_CN](README_CN.md) | 用户完全感知不到新功能 | +| `registry.ts` 注册新命令但忘了 [README](README.md) / [README.zh](README.zh.md) | 用户完全感知不到新功能 | | 共享 util 重构(抽公共函数)只改了一处调用方 | 其它调用方静默走旧分支,行为分裂 | | `NO_AUTH_SETUP` 加了不该免登录的命令 | 安全风险,用户没登录也能调付费 API | | `NO_AUTH_SETUP` / `registry.ts` 这类全局表两边都加项,解冲突时被合掉一侧 | 某个命令突然要求登录 / 某个新命令注册丢失,编译能过、回归不易察觉 | diff --git a/docs/agents/command-add-remove.md b/docs/agents/command-add-remove.md index f6fbc2e..bdc0763 100644 --- a/docs/agents/command-add-remove.md +++ b/docs/agents/command-add-remove.md @@ -60,7 +60,7 @@ registry.ts main.ts tools/generate-reference.ts export-schema.ts ### B. 文档层 - [ ] 运行 `pnpm run sync:skill-assets`(或正常 `git commit` 走 pre-commit),刷新 `skills/bailian-cli/reference/` 与 `SKILL.md` 的 `metadata.version` 并提交 -- [ ] `README.md` / `README_CN.md`: Quick Start、命令一览(用户向,与 help 对齐即可) +- [ ] `README.md` / `README.zh.md`: Quick Start、命令一览(用户向,与 help 对齐即可) - [ ] `skills/bailian-cli/SKILL.md`: 若安装说明或能力边界有变,同步更新 ### C. 测试层 diff --git a/docs/agents/command-flag-change.md b/docs/agents/command-flag-change.md index 049e854..46d610c 100644 --- a/docs/agents/command-flag-change.md +++ b/docs/agents/command-flag-change.md @@ -28,7 +28,7 @@ ### C. 文档层 -- [ ] `README.md` / `README_CN.md` 如果在示例里展示了相关命令,补充新 flag +- [ ] `README.md` / `README.zh.md` 如果在示例里展示了相关命令,补充新 flag - [ ] 跑 `pnpm --filter bailian-cli run generate:reference`,让 `skills/bailian-cli/reference/` 与命令一致(勿手改;改完提交) ### D. 测试层 diff --git a/docs/agents/config-add.md b/docs/agents/config-add.md index 207d6ce..2e42fc7 100644 --- a/docs/agents/config-add.md +++ b/docs/agents/config-add.md @@ -54,7 +54,7 @@ config 文件 ─┘ ### E. 文档 -- [ ] `README.md` / `README_CN.md` 的 env var 表格 +- [ ] `README.md` / `README.zh.md` 的 env var 表格 ### F. 测试 diff --git a/docs/agents/model-add-remove.md b/docs/agents/model-add-remove.md index 11a25ad..0760dcc 100644 --- a/docs/agents/model-add-remove.md +++ b/docs/agents/model-add-remove.md @@ -29,7 +29,7 @@ ### D. 用户面文档 -- [ ] `README.md` / `README_CN.md`: +- [ ] `README.md` / `README.zh.md`: - Quick Start 示例如使用了具体型号,确认仍可用 - 顶部 introduction 段落如提到"Qwen-Omni"等品牌名,无需变(模型代号变化不算品牌变) diff --git a/docs/agents/publish.md b/docs/agents/publish.md index 418e66d..fcb3e4a 100644 --- a/docs/agents/publish.md +++ b/docs/agents/publish.md @@ -69,7 +69,7 @@ node tools/release/publish-channel.mjs --channel test --dry-run ### 用户面文档 -- [ ] `README.md` / `README_CN.md` 的 Quick Start 命令仍能跑通 +- [ ] `README.md` / `README.zh.md` 的 Quick Start 命令仍能跑通 - [ ] README 的 Node.js 徽章版本与 `cli/package.json.engines.node` 一致 - [ ] README 宣传的 bin 名称在 `cli/package.json.bin` 都真的注册 - [ ] `LICENSE` 文件存在（根 + cli + core 各一份） diff --git a/docs/agents/url-change.md b/docs/agents/url-change.md index de61775..872db28 100644 --- a/docs/agents/url-change.md +++ b/docs/agents/url-change.md @@ -47,7 +47,7 @@ grep -rnE "https://dashscope[a-z-]*\.aliyuncs\.com" packages/ --include="*.ts" \ ### B. 非 TS 文件(只能人工同步,无法 import) - [ ] `skills/bailian-cli/reference/` 各 `.md` 中 API/控制台 URL(`generate:reference` 重建后核对并提交) -- [ ] `README.md` / `README_CN.md` 中所有 URL +- [ ] `README.md` / `README.zh.md` 中所有 URL ### C. 渠道追踪参数 diff --git a/packages/cli/README.md b/packages/cli/README.md index 790bf78..52eae74 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -9,7 +9,7 @@ [![TypeScript](https://img.shields.io/badge/TypeScript-strict-3178c6)](https://www.typescriptlang.org) [![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE) -[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README_CN.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&) +[Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&) · [中文文档](https://github.com/modelstudioai/cli/blob/main/README.zh.md) · [API Documentation](https://help.aliyun.com/zh/model-studio/) · [Get API Key](https://bailian.console.aliyun.com/cli?source_channel=key_github&) --- diff --git a/packages/cli/README_CN.md b/packages/cli/README.zh.md similarity index 100% rename from packages/cli/README_CN.md rename to packages/cli/README.zh.md diff --git a/packages/core/README.md b/packages/core/README.md index 8102182..f63e0c0 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,6 +1,6 @@ # bailian-cli-core -[English](./README.md) | [简体中文](./README_CN.md) +[English](./README.md) | [简体中文](./README.zh.md) Internal SDK for [`bailian-cli`](https://www.npmjs.com/package/bailian-cli). diff --git a/packages/core/README_CN.md b/packages/core/README.zh.md similarity index 85% rename from packages/core/README_CN.md rename to packages/core/README.zh.md index 70f87cd..7c90b52 100644 --- a/packages/core/README_CN.md +++ b/packages/core/README.zh.md @@ -1,6 +1,6 @@ # bailian-cli-core -[English](./README.md) | [简体中文](./README_CN.md) +[English](./README.md) | [简体中文](./README.zh.md) [`bailian-cli`](https://www.npmjs.com/package/bailian-cli) 的内部 SDK。 diff --git a/skills/bailian-cli/README.md b/skills/bailian-cli/README.md new file mode 100644 index 0000000..fffbede --- /dev/null +++ b/skills/bailian-cli/README.md @@ -0,0 +1,11 @@ +# bailian-cli + +> [中文版 / Chinese →](README.zh.md) + +Agent skill for **Alibaba Cloud Model Studio CLI** (`bl`) — teaches your AI agent to use `bl` commands for chat, multimodal, image/video generation, speech, vision, apps, memory, RAG, web search, and more. + +For CLI installation, authentication, command reference, and examples, see the [main README](../../README.md). + +## License + +Apache-2.0 diff --git a/skills/bailian-cli/README.zh.md b/skills/bailian-cli/README.zh.md new file mode 100644 index 0000000..8b491d1 --- /dev/null +++ b/skills/bailian-cli/README.zh.md @@ -0,0 +1,11 @@ +# 百炼 CLI + +> [English →](README.md) + +**阿里云百炼 CLI**（`bl`）的 Agent 技能 — 教会你的 AI Agent 使用 `bl` 命令完成对话、多模态、图像/视频生成与编辑、语音、视觉、应用调用、记忆、RAG、联网搜索等任务。 + +CLI 的安装、认证、命令参考和使用示例请查看[主 README](../../README.zh.md)。 + +## License + +Apache-2.0