From a03ba673be7755700ba3a69e213e8ada24aa93f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8B=A5=E9=BA=92?= Date: Fri, 17 Jul 2026 15:57:23 +0800 Subject: [PATCH 1/3] fix(auth): clear model base URL on full logout --- docs/agents/auth-change.md | 2 +- docs/agents/cli-e2e-tests.md | 3 +- packages/commands/src/commands/auth/logout.ts | 14 ++++---- packages/commands/tests/e2e/auth.e2e.test.ts | 32 +++++++++++++++++++ packages/core/src/auth/store.ts | 11 +++++-- packages/core/tests/config-store.test.ts | 5 +++ skills/bailian-cli/assets/setup.md | 2 +- skills/bailian-cli/reference/auth.md | 12 +++---- skills/bailian-cli/reference/index.md | 2 +- 9 files changed, 64 insertions(+), 19 deletions(-) diff --git a/docs/agents/auth-change.md b/docs/agents/auth-change.md index 4c6dbe8b..55f92ba9 100644 --- a/docs/agents/auth-change.md +++ b/docs/agents/auth-change.md @@ -38,7 +38,7 @@ defineCommand({ auth }) → runtime/authStage → ctx.client → command.run(ctx - `bl auth login --open-api ...` 只更新 `access_key_id` / `access_key_secret` - `bl auth logout --console` 只清 `access_token` - `bl auth logout --open-api` 只清 `access_key_id` / `access_key_secret` / `security_token` -- `bl auth logout` 清 `api_key` + `access_token` + `access_key_*` +- `bl auth logout` 清 `api_key` + `base_url` + `access_token` + `access_key_*` 解析分工: diff --git a/docs/agents/cli-e2e-tests.md b/docs/agents/cli-e2e-tests.md index 2ca45f09..4c1aafbb 100644 --- a/docs/agents/cli-e2e-tests.md +++ b/docs/agents/cli-e2e-tests.md @@ -85,7 +85,8 @@ describe.skipIf()("e2e: （DashScope …）", () => { ## 安全与例外 -- **禁止真实破坏性操作**：`auth logout` 只用 `--dry-run`；`config set` 只用 `--dry-run` +- **禁止破坏真实用户配置**：`auth logout` 默认只用 `--dry-run`；需要验证实际落盘时，必须通过 + `BAILIAN_CONFIG_DIR` 指向隔离 fixture；`config set` 只用 `--dry-run` - **不加 dry-run**：`dryRun` 在 `resolveFileUrl` / `resolveCredential` / 上传**之后**的命令（如 `image edit`、`speech recognize` 带 `--url`） - **`--list-voices` 等旁路**：先于 `--text` 校验的 flag，缺参用例勿带该 flag - 新增 required option → 至少一条缺参用例；改 dry-run 输出 → 更新对应断言 diff --git a/packages/commands/src/commands/auth/logout.ts b/packages/commands/src/commands/auth/logout.ts index 2a598ab4..2a2860a0 100644 --- a/packages/commands/src/commands/auth/logout.ts +++ b/packages/commands/src/commands/auth/logout.ts @@ -2,7 +2,7 @@ import { defineCommand } from "bailian-cli-core"; import { emitBare } from "bailian-cli-runtime"; export default defineCommand({ - description: "Clear stored credentials", + description: "Clear stored credentials; full logout also clears the model Base URL", auth: "none", usageArgs: "[--console | --open-api] [--dry-run]", flags: { @@ -68,24 +68,24 @@ export default defineCommand({ return; } - const hasKey = stored.apiKey || stored.console || stored.openapi; + const hasStoredAuth = stored.apiKey || stored.console || stored.openapi || !!stored.baseUrl; if (settings.dryRun) { - if (hasKey) + if (hasStoredAuth) emitBare( - `Would clear api_key / access_token / access_key_id / access_key_secret / security_token from ${store.path}`, + `Would clear api_key / base_url / access_token / access_key_id / access_key_secret / security_token from ${store.path}`, ); - else emitBare("No credentials to clear."); + else emitBare("No credentials or model Base URL to clear."); emitBare("No changes made."); return; } if (await store.logout("all")) { process.stderr.write( - `Cleared api_key / access_token / access_key_id / access_key_secret / security_token from ${store.path}\n`, + `Cleared api_key / base_url / access_token / access_key_id / access_key_secret / security_token from ${store.path}\n`, ); } else { - process.stderr.write("No credentials to clear.\n"); + process.stderr.write("No credentials or model Base URL to clear.\n"); } }, }); diff --git a/packages/commands/tests/e2e/auth.e2e.test.ts b/packages/commands/tests/e2e/auth.e2e.test.ts index f1461e71..505e0823 100644 --- a/packages/commands/tests/e2e/auth.e2e.test.ts +++ b/packages/commands/tests/e2e/auth.e2e.test.ts @@ -478,6 +478,38 @@ describe("e2e: auth", () => { expect(stderr).not.toContain("Cleared api_key"); }); + test("auth logout 清除当前 Config 的全部凭证和 Base URL，保留普通配置", async () => { + const configDir = makeE2eOutputDir("auth-logout-all"); + writeFileSync( + join(configDir, "config.json"), + JSON.stringify( + { + api_key: "sk-e2e-placeholder", + base_url: "https://model.example.com", + access_token: "console-token-placeholder", + access_key_id: "LTAI-e2e-placeholder", + access_key_secret: "secret-e2e-placeholder", + security_token: "sts-e2e-placeholder", + output: "json", + }, + null, + 2, + ) + "\n", + ); + + const { stderr, exitCode } = await runCommandE2e(AUTH_ROUTES, ["auth", "logout"], { + BAILIAN_CONFIG_DIR: configDir, + }); + expect(exitCode, stderr).toBe(0); + expect(stderr).toContain("api_key / base_url / access_token"); + + const config = JSON.parse(readFileSync(join(configDir, "config.json"), "utf8")) as Record< + string, + unknown + >; + expect(config).toEqual({ output: "json" }); + }); + test.skipIf(!isDashScopeE2EReady())("auth status 文本输出", async () => { const { stdout, stderr, exitCode } = await runCommandE2e(AUTH_ROUTES, [ "auth", diff --git a/packages/core/src/auth/store.ts b/packages/core/src/auth/store.ts index c7621887..33572107 100644 --- a/packages/core/src/auth/store.ts +++ b/packages/core/src/auth/store.ts @@ -9,7 +9,14 @@ import { describeAuthState, resolveModelBaseUrl } from "./resolver.ts"; const LOGOUT_KEYS = { console: ["access_token"], openapi: ["access_key_id", "access_key_secret", "security_token"], - all: ["api_key", "access_token", "access_key_id", "access_key_secret", "security_token"], + all: [ + "api_key", + "base_url", + "access_token", + "access_key_id", + "access_key_secret", + "security_token", + ], } as const; /** 登录允许落盘的键:凭证本体 + 登录回调携带的连接/作用域字段。 */ @@ -42,7 +49,7 @@ export interface AuthStore { resolveBaseUrl(fallback?: string): string; /** 登录落盘:合并写入,undefined 键忽略；显式 --config 成功后同时激活目标 Profile。 */ login(patch: AuthPersistPatch): Promise; - /** 清凭证:console/openapi 只删对应域;all 清全部登录凭证。返回是否有变更。 */ + /** 清凭证:console/openapi 只删对应域;all 清全部登录凭证和 model baseUrl。返回是否有变更。 */ logout(scope: "console" | "openapi" | "all"): Promise; /** 实际写入的 config.json 路径(不受命名配置影响,一直是同一个文件)。 */ path: string; diff --git a/packages/core/tests/config-store.test.ts b/packages/core/tests/config-store.test.ts index 8cc12a00..c266797e 100644 --- a/packages/core/tests/config-store.test.ts +++ b/packages/core/tests/config-store.test.ts @@ -73,6 +73,7 @@ test("AuthStore:login 合并落盘,logout 按域清理并报告变更", async () const store = makeAuthStore({ flags: {}, file: {}, env: {} }); await store.login({ api_key: "sk-1", + base_url: "https://model.example.com/compatible-mode/v1", access_token: "tok-1", access_key_id: "ak-1", access_key_secret: "secret-1", @@ -82,6 +83,7 @@ test("AuthStore:login 合并落盘,logout 按域清理并报告变更", async () }); expect(makeConfigStore().read()).toMatchObject({ api_key: "sk-1", + base_url: "https://model.example.com", access_token: "tok-1", workspace_id: "ws-1", console_site: "international", @@ -90,15 +92,18 @@ test("AuthStore:login 合并落盘,logout 按域清理并报告变更", async () expect(await store.logout("console")).toBe(true); expect(makeConfigStore().read().access_token).toBeUndefined(); expect(makeConfigStore().read().api_key).toBe("sk-1"); + expect(makeConfigStore().read().base_url).toBe("https://model.example.com"); expect(await store.logout("openapi")).toBe(true); expect(makeConfigStore().read()).toMatchObject({ api_key: "sk-1" }); + expect(makeConfigStore().read().base_url).toBe("https://model.example.com"); expect(makeConfigStore().read().access_key_id).toBeUndefined(); expect(makeConfigStore().read().access_key_secret).toBeUndefined(); expect(makeConfigStore().read().security_token).toBeUndefined(); expect(await store.logout("all")).toBe(true); expect(makeConfigStore().read().api_key).toBeUndefined(); + expect(makeConfigStore().read().base_url).toBeUndefined(); expect(await store.logout("all")).toBe(false); // 非凭证键不受 logout 影响 diff --git a/skills/bailian-cli/assets/setup.md b/skills/bailian-cli/assets/setup.md index 4869de9d..dd6a5eb5 100644 --- a/skills/bailian-cli/assets/setup.md +++ b/skills/bailian-cli/assets/setup.md @@ -30,7 +30,7 @@ Verify: `bl --version` (prints `bl X.Y.Z`). ```bash bl auth status # check current auth -bl auth logout # clear credentials +bl auth logout # clear credentials and the model Base URL bl auth logout --console # clear console token only bl auth logout --open-api # clear OpenAPI AK/SK only ``` diff --git a/skills/bailian-cli/reference/auth.md b/skills/bailian-cli/reference/auth.md index 5002c39e..016699a1 100644 --- a/skills/bailian-cli/reference/auth.md +++ b/skills/bailian-cli/reference/auth.md @@ -11,7 +11,7 @@ Index: [index.md](index.md) | ------------------------------- | -------------------------------------------------------------------------------------------- | | `bl auth generate-access-token` | Generate a CLI access token using OpenAPI AK/SK | | `bl auth login` | Authenticate with API key, console browser login, or OpenAPI AK/SK (credentials can coexist) | -| `bl auth logout` | Clear stored credentials | +| `bl auth logout` | Clear stored credentials; full logout also clears the model Base URL | | `bl auth status` | Show current authentication state | ## Command details @@ -78,11 +78,11 @@ bl auth login --open-api --access-key-id LTAIxxxxx --access-key-secret xxxxx ### `bl auth logout` -| Field | Value | -| --------------- | ------------------------------------------------------ | -| **Name** | `auth logout` | -| **Description** | Clear stored credentials | -| **Usage** | `bl auth logout [--console \| --open-api] [--dry-run]` | +| Field | Value | +| --------------- | -------------------------------------------------------------------- | +| **Name** | `auth logout` | +| **Description** | Clear stored credentials; full logout also clears the model Base URL | +| **Usage** | `bl auth logout [--console \| --open-api] [--dry-run]` | #### Flags diff --git a/skills/bailian-cli/reference/index.md b/skills/bailian-cli/reference/index.md index 132c4a1c..b521b03b 100644 --- a/skills/bailian-cli/reference/index.md +++ b/skills/bailian-cli/reference/index.md @@ -15,7 +15,7 @@ Use this index for the full quick index and global flags. | `bl app list` | List Bailian applications | [app.md](app.md) | | `bl auth generate-access-token` | Generate a CLI access token using OpenAPI AK/SK | [auth.md](auth.md) | | `bl auth login` | Authenticate with API key, console browser login, or OpenAPI AK/SK (credentials can coexist) | [auth.md](auth.md) | -| `bl auth logout` | Clear stored credentials | [auth.md](auth.md) | +| `bl auth logout` | Clear stored credentials; full logout also clears the model Base URL | [auth.md](auth.md) | | `bl auth status` | Show current authentication state | [auth.md](auth.md) | | `bl config list` | List config profiles and show the active profile | [config.md](config.md) | | `bl config set` | Set a config value | [config.md](config.md) | From a853319dd02dc818c7548d32d2135e2fb597b89c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8B=A5=E9=BA=92?= Date: Sun, 19 Jul 2026 16:05:35 +0800 Subject: [PATCH 2/3] feat(onboarding): add Token Plan setup guidance - add Token Plan subscription and login entry to CLI, README, INSTALL, and skill - document built-in Base URL and automatic key validation - remove the completed Token Plan integration design document --- INSTALL.md | 20 +- README.md | 13 + README.zh.md | 13 + docs/agents/url-change.md | 1 + docs/token-plan-profile-integration.md | 565 ------------------------- packages/cli/README.md | 13 + packages/cli/README.zh.md | 13 + packages/runtime/src/index.ts | 8 +- packages/runtime/src/output/banner.ts | 7 +- packages/runtime/src/urls.ts | 3 + skills/bailian-cli/SKILL.md | 2 + skills/bailian-cli/assets/setup.md | 9 +- 12 files changed, 92 insertions(+), 575 deletions(-) delete mode 100644 docs/token-plan-profile-integration.md diff --git a/INSTALL.md b/INSTALL.md index 75ffab27..ca202f1f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -69,7 +69,7 @@ npx skills add modelstudioai/cli --all -g > 此方式同时打通 `app list`、`usage free` 等控制台能力，并自动配置 API Key 调用所需的鉴权信息。 -### 备选：由 Agent 引导用户输入 API Key 后登录 +### 备选一：由 Agent 引导用户输入普通 API Key 后登录 适用于无法拉起浏览器的对话式安装（远程 SSH、CI 调试、纯终端环境等）： @@ -80,6 +80,15 @@ npx skills add modelstudioai/cli --all -g 3. 用户提供了 Key 之后，在**用户本机终端**执行（Agent 用终端工具跑，勿把 Key 写进回复正文）：`bl auth login --api-key <用户提供的_Key>` 4. 登录成功后执行 `bl auth status --output json` 确认；汇报时只使用 masked 字段，**禁止**回显完整 Key。 +### 备选二：使用 Token Plan API Key + +- 获取入口：[Token Plan 订阅详情](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview) + +1. 请用户从订阅详情页获取或复制 Token Plan API Key，勿要求用户发到公开渠道。 +2. 在用户本机终端执行：`bl auth login --config token-plan --api-key <用户提供的_Key>`。 +3. `token-plan` Profile 已内置默认 Base URL；登录命令会先测试 Key，通过后才保存并激活该 Profile，无需另行配置或重复测试。 +4. 执行 `bl auth status --config token-plan --output json` 确认；汇报时只使用 masked 字段。 + ### 其他方式 - **环境变量**（不落盘到配置文件）：在 shell 中配置 API Key 环境变量；变量名见 `bl auth status --help`，勿在对话中向用户解释底层命名。 @@ -93,16 +102,15 @@ npx skills add modelstudioai/cli --all -g --- -## 4. 最小功能验证 +## 4. 配置验证 -在鉴权配置完成后执行： +API Key 登录命令本身已经完成可用性测试，通过后只需确认配置状态： ```bash bl auth status --output json -bl text chat --message "ping" --non-interactive --output json ``` -若失败：根据 stderr / JSON 中的 `hint` 或 `message` 排查（网络、Key 无效、`base_url` 等）。DashScope 端点：使用 `--base-url` / `bl config set --key base_url` / `DASHSCOPE_BASE_URL`，默认中国大陆 `https://dashscope.aliyuncs.com`。 +无需再执行重复的模型调用测试。若登录失败，根据 stderr / JSON 中的 `hint` 或 `message` 排查（网络、Key 无效、`base_url` 等）。DashScope 端点：使用 `--base-url` / `bl config set --key base_url` / `DASHSCOPE_BASE_URL`，默认中国大陆 `https://dashscope.aliyuncs.com`。 --- @@ -112,6 +120,6 @@ bl text chat --message "ping" --non-interactive --output json | ----------------------- | -------------------- | --------------------------------------------------------------- | | `bl: command not found` | 全局 bin 不在 PATH | 检查 `npm prefix -g` 与 PATH | | 安装报错 engines | Node 版本过低 | 升级到 ≥ 22.12 | -| 401 / 鉴权失败 | 未 login 或 Key 无效 | 引导用户更新 Key 并 `bl auth login --api-key` | +| 401 / 鉴权失败 | 未 login 或 Key 无效 | 按 Key 类型重新执行普通或 Token Plan 登录命令 | | 企业网络无法访问 npm | 代理 / 镜像 | 配置 registry 或代理后再装 | | 本机只有 pnpm、没有 npm | Agent 误用 pnpm 安装 | 先装/修好 **npm**，再用 `npm install -g bailian-cli`；勿用 pnpm | diff --git a/README.md b/README.md index 1a8d367c..3823cade 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,9 @@ bl auth login --console # Or authenticate with an API key bl auth login --api-key sk-xxxxx +# Or use Token Plan (Base URL built in; the key is tested during login) +bl auth login --config token-plan --api-key sk-sp-xxxxx + # Chat with Qwen bl text chat --message "What is DashScope?" @@ -159,6 +162,15 @@ bl auth login --api-key sk-xxxxx bl text chat --api-key sk-xxxxx --message "Hello" ``` +### Token Plan API Key + +Get or copy the API key from the [Token Plan subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview). +The CLI has the default Token Plan Base URL built in. Login tests the key first, then saves and activates the `token-plan` config only when validation succeeds. + +```bash +bl auth login --config token-plan --api-key sk-sp-xxxxx +``` + ### Console Login (OAuth) Required for console capability commands (`model list`, `app list`, `usage summary/free/stats`, `workspace list`, `quota list/request/check/history`). Opens the Bailian console in your browser to sign in. @@ -209,6 +221,7 @@ Config file location: `~/.bailian/config.json` | Qwen Model List | https://help.aliyun.com/zh/model-studio/getting-started/models | | Aliyun Model Studio Console | https://bailian.console.aliyun.com/?source_channel=cli_github | | Get API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key | +| Get Token Plan API Key | https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview | | Get AccessKey | https://ram.console.aliyun.com/manage/ak | ## Changelog diff --git a/README.zh.md b/README.zh.md index 970e53f2..8e43706d 100644 --- a/README.zh.md +++ b/README.zh.md @@ -89,6 +89,9 @@ bl auth login --console # 或使用 API key 认证 bl auth login --api-key sk-xxxxx +# 或使用 Token Plan（已内置 Base URL，登录时自动测试 Key） +bl auth login --config token-plan --api-key sk-sp-xxxxx + # 和通义千问对话 bl text chat --message "你好，介绍一下阿里云百炼平台" @@ -157,6 +160,15 @@ bl auth login --api-key sk-xxxxx bl text chat --api-key sk-xxxxx --message "你好" ``` +### Token Plan API Key + +前往 [Token Plan 订阅详情](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview) 获取或复制 API Key。 +CLI 已内置 Token Plan 的默认 Base URL；登录命令会先测试 Key，通过后才保存并激活 `token-plan` 配置。 + +```bash +bl auth login --config token-plan --api-key sk-sp-xxxxx +``` + ### 控制台登录（OAuth） 控制台能力命令（`model list`、`app list`、`usage summary/free/stats`、`workspace list`、`quota list/request/check/history`）需要使用此登录方式。打开浏览器跳转百炼控制台完成登录。 @@ -207,6 +219,7 @@ bl update | 通义千问模型列表 | https://help.aliyun.com/zh/model-studio/getting-started/models | | 阿里云百炼控制台 | https://bailian.console.aliyun.com/?source_channel=cli_github | | 获取 API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key | +| 获取 Token Plan API Key | https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview | | 获取 AccessKey | https://ram.console.aliyun.com/manage/ak | ## 更新日志 diff --git a/docs/agents/url-change.md b/docs/agents/url-change.md index 2bc4c1cc..0292eecd 100644 --- a/docs/agents/url-change.md +++ b/docs/agents/url-change.md @@ -19,6 +19,7 @@ runtime/src/urls.ts ← 用户面控制台 URL(cn-only) BAILIAN_CONSOLE_ROOT bailian.console.aliyun.com BAILIAN_CONSOLE BAILIAN_CONSOLE_ROOT/cn-beijing API_KEY_PAGE BAILIAN_CONSOLE/?tab=app#/api-key + TOKEN_PLAN_PAGE BAILIAN_CONSOLE_ROOT/cn-beijing?tab=plan#/efm/subscription/overview core/files/upload.ts ← 文件上传 endpoint(cn-pinned) UPLOAD_API ${REGIONS.cn}/api/v1/uploads diff --git a/docs/token-plan-profile-integration.md b/docs/token-plan-profile-integration.md deleted file mode 100644 index f62adf86..00000000 --- a/docs/token-plan-profile-integration.md +++ /dev/null @@ -1,565 +0,0 @@ -# Token Plan Profile 与激活配置接入方案 - -> 状态：Token Plan 模型消费、Config 激活状态与通用 Base URL 归一化均已实现。 -> -> 目标分支：`feat/cli-access-token`。 - -## 结论摘要 - -Token Plan 的模型消费能力继续使用现有 `apiKey` 鉴权域和模型 Client，不新增 Token Plan 鉴权模式或专用 Client。 - -本次接入拆为三类相互独立的能力，并按业务紧急度而不是最终调用链顺序交付： - -1. 优先完成 `token-plan` 内置 Profile 预设、登录和文本/图片消费。 -2. 然后完成 Config 激活状态，允许用户选择未传 `--config` 时默认使用的命名配置。 -3. 最后以独立 commit 完成通用模型 Base URL 归一化，覆盖所有输入来源，不只服务 Token Plan。 - -`token-plan` 是有默认值的内置 Profile 名，不是 `active_auth_mode`，也不是新的 `AuthRequirement`。 - -## 背景与边界 - -当前分支已经包含以下 Token Plan 管控命令： - -```text -token-plan list-seats -token-plan create-key -token-plan assign-seats -token-plan add-member -``` - -这些命令属于管理面，继续使用 OpenAPI AK/SK。本方案增加的是模型消费面：用户把 `create-key` 获得的 `PlainApiKey` 保存到 Profile，然后通过现有文本和图片命令调用模型。 - -```text -OpenAPI AK/SK - -> token-plan create-key - -> PlainApiKey - -> auth login --config token-plan - -> text/image model command -``` - -### 目标 - -- 将 Token Plan 模型 API Key 作为普通 `apiKey` credential 使用。 -- 将 `token-plan` 作为内置命名 Profile 管理。 -- 支持 Config 激活状态和默认切换。 -- 复用现有文本、图片命令与 Client。 -- 对所有来源的模型 Base URL 做统一归一化。 -- 登录验证成功后原子保存 API Key 和 Base URL。 -- 服务端错误保持原消息，不在 CLI 内翻译。 - -### 非目标 - -- 不重写现有 Token Plan 管控命令。 -- 不把模型消费 API Key 合并到 OpenAPI AK/SK 鉴权域。 -- 不新增 Token Plan 专用 Client。 -- 基础阶段不承诺视频、语音和音频模型消费。 -- 暂不维护会阻断请求的本地模型白名单。 -- 暂不把服务端错误翻译成 CLI 自定义错误。 - -## 用户交互 - -### 1. 配置 Token Plan - -`token-plan` 提供默认 Base URL，因此推荐登录命令不要求用户输入地址： - -```sh -bl auth login \ - --config token-plan \ - --api-key sk-sp-xxx -``` - -CLI 应解析并保存以下配置： - -```json -{ - "active_config": "token-plan", - "token-plan": { - "api_key": "", - "base_url": "https://token-plan.cn-beijing.maas.aliyuncs.com", - "default_text_model": "qwen3.7-max", - "default_image_model": "qwen-image-2.0" - } -} -``` - -凭证验证和配置落盘成功后，CLI 在同一次配置文件写入中将 `token-plan` 设为激活项；验证失败和 -dry-run 不创建、不切换 Profile。 - -用户仍可显式覆盖 Base URL，用于代理、测试或未来新增地域： - -```sh -bl auth login \ - --config token-plan \ - --api-key sk-sp-xxx \ - --base-url https://proxy.example.com/bailian/compatible-mode/v1 -``` - -显式地址归一化后应保存为： - -```text -https://proxy.example.com/bailian -``` - -推荐路径仍是不传 `--base-url`，直接使用 `token-plan` 预设中的 canonical 根地址。显式覆盖时可以传服务根地址、自定义代理前缀，或带 `/compatible-mode/v1`、`/apps/anthropic` 的 SDK Base URL；CLI 会在验证和落盘前统一归一化。 - -### 2. 单次选择 Config - -`--config` 只影响当前命令，不修改激活状态： - -```sh -bl text chat --config token-plan --message "你好" -bl image generate --config token-plan --prompt "一只猫" -``` - -### 3. 激活 Config - -登录时显式选择的 Profile 会自动激活；之后也可以主动切换： - -```sh -bl config use --name token-plan -``` - -激活后，未传 `--config` 的命令默认使用 `token-plan`： - -```sh -bl text chat --message "你好" -bl image generate --prompt "一只猫" -``` - -切回顶层默认配置： - -```sh -bl config use --name default -``` - -单次绕过当前激活项、临时使用其他 Profile： - -```sh -bl text chat --config staging --message "你好" -``` - -单次显式使用顶层默认配置： - -```sh -bl text chat --config default --message "你好" -``` - -上述两种单次覆盖都不得改变持久化的激活状态。 - -### 4. 查看 Config - -新增列表能力，用于展示所有 Profile 和当前激活项： - -```sh -bl config list -``` - -示例输出： - -```text -NAME ACTIVE -default -staging -token-plan * -``` - -`config show` 和 `auth status` 的行为： - -- 未传 `--config`：展示当前激活的 Config。 -- 传 `--config `：展示指定 Config，不改变激活状态。 -- 输出中包含最终选择的 `config` 和 `config_file`；激活状态统一由 `config list` / `config ui` 展示。 - -`config ui` 应展示当前激活项，并提供激活操作。 - -## Config 激活状态设计 - -### 存储形状 - -激活状态保存在 `~/.bailian/config.json` 顶层元数据中： - -```json -{ - "active_config": "token-plan", - "api_key": "", - "token-plan": { - "api_key": "", - "base_url": "https://token-plan.cn-beijing.maas.aliyuncs.com" - } -} -``` - -`active_config` 只允许出现在顶层，不属于单个 Profile 的业务字段。允许值为： - -- `default`：顶层默认配置。 -- 一个实际存在的命名 Profile。 - -旧配置没有 `active_config` 时等价于： - -```json -{ - "active_config": "default" -} -``` - -因此该能力对现有用户向后兼容。 - -### 选择优先级 - -Config block 的选择顺序为： - -```text -显式 --config - > active_config - > default -``` - -需要保留“参数是否出现”的信息： - -- 未传 `--config`：读取 `active_config`。 -- `--config default`：明确选择顶层配置，不能被 `active_config` 替换。 -- `--config `：明确选择该命名 Profile。 - -当前 `normalizeConfigName("default")` 会返回 `undefined`，实现时不能只根据归一化结果判断参数是否出现。 - -Config 激活只改变配置文件 block 的选择，`--config` 本身不提升所选 block 的字段优先级。运行时和 Base URL 登录验证保持“具体字段 flag > 环境变量 > selected config file > Profile 预设或系统默认值”。环境变量只影响本次有效值，不复制进 Profile；登录成功时，如果 Token Plan Profile 尚未保存 `base_url`，仍物化写入官方预设地址。Token Plan 默认模型是例外：每次登录都重置为内置版本。`config show` / `auth status` 应展示最终生效来源，避免用户误判套餐流量去向。 - -### 异常状态 - -- 激活不存在的 Profile：`config use` 返回 usage error，不写入状态。 -- 配置文件中的 `active_config` 指向不存在的 Profile：命令失败并提示切回 `default`，不得静默使用其他凭证。 -- 删除当前激活的 Profile：删除操作同时切回 `default`，或者要求用户先切换；不能保留悬空引用。 -- `config use --name token-plan` 只切换状态，不创建 Profile，也不执行登录。 -- `auth login --config token-plan` 在凭证验证并落盘成功后自动激活该 Profile；验证失败和 - dry-run 不创建、不切换。 - -## `token-plan` 内置 Profile 预设 - -`token-plan` 是允许用户选择的内置 Profile 名，不应加入非法名称列表。它提供以下默认值： - -```text -base_url: https://token-plan.cn-beijing.maas.aliyuncs.com -default_text_model: qwen3.7-max -default_image_model: qwen-image-2.0 -``` - -Token Plan Base URL 预设只在登录写入阶段提供最低优先级的缺省值： - -```text -显式命令参数 - > 环境变量 - > 已保存的 Profile 字段 - > token-plan 预设值 -``` - -登录成功时应把显式 Base URL 或缺失的预设 Base URL，以及默认模型写入 Profile，使 `config show --config token-plan` 能看到完整配置。环境变量不复制进 Profile。运行时不再合并预设；如果手工删除字段，则按统一的环境变量、配置文件和系统默认值链继续解析。 - -默认模型采用更简单的固定策略：每次执行 `auth login --config token-plan`，都将 `default_text_model` 重置为 `qwen3.7-max`，将 `default_image_model` 重置为 `qwen-image-2.0`。登录不保留用户之前写入的其他 Profile 默认模型；用户需要临时调用其他 Token Plan 模型时，通过具体模型命令的 `--model` 覆盖，不修改这两个内置默认值。 - -预设建议通过集中 registry 表达，不在 resolver、命令和 Client 中散落名称判断： - -```ts -const MODEL_PROFILE_PRESETS = { - "token-plan": { - baseUrl: "https://token-plan.cn-beijing.maas.aliyuncs.com", - defaultTextModel: "qwen3.7-max", - defaultImageModel: "qwen-image-2.0", - }, -}; -``` - -Profile 预设不改变命令协议： - -```text -Selected Profile - -> API Key Credential - -> Client - -> Command Endpoint -``` - -## 通用模型 Base URL 归一化 - -Base URL 归一化是独立的通用能力，不针对 Token Plan hostname 做特判。 - -### 语义 - -CLI 中 `base_url` 表示模型服务根地址或自定义网关前缀，不包含 CLI 已知的 SDK/API Base 后缀。 - -建议新增统一函数： - -```text -normalizeModelBaseUrl(input) -> canonical base URL -``` - -通用规则： - -1. 去除首尾空白。 -2. 使用 `URL` 解析，只接受 `http:` 和 `https:`。 -3. 去除 query 和 fragment。 -4. 去除末尾 `/`。 -5. 保留协议、hostname、端口和自定义代理路径。 -6. 去除末尾已知 SDK/API Base 后缀，例如： - - `/compatible-mode/v1` - - `/apps/anthropic` -7. 不无条件返回 `url.origin`，避免破坏自定义代理路径。 - -示例： - -| 用户输入 | 归一化结果 | -| -------------------------------------------------------------------- | ------------------------------------------------- | -| `https://dashscope.aliyuncs.com/` | `https://dashscope.aliyuncs.com` | -| `https://token-plan.cn-beijing.maas.aliyuncs.com/compatible-mode/v1` | `https://token-plan.cn-beijing.maas.aliyuncs.com` | -| `https://token-plan.cn-beijing.maas.aliyuncs.com/apps/anthropic` | `https://token-plan.cn-beijing.maas.aliyuncs.com` | -| `https://proxy.example.com/bailian/` | `https://proxy.example.com/bailian` | -| `https://proxy.example.com/bailian/compatible-mode/v1` | `https://proxy.example.com/bailian` | - -### 覆盖入口 - -所有模型 Base URL 来源都必须经过同一个函数： - -- 模型命令的 `--base-url`。 -- `DASHSCOPE_BASE_URL`。 -- `config.json` 中的 `base_url`。 -- `config set --key base_url`。 -- `config ui`。 -- `auth login --base-url`。 -- Console 登录回调返回的 `base_url`。 -- 手工修改的旧配置。 -- 内置默认地址和 Profile 预设地址。 - -归一化采用双层防线： - -- 写入前归一化，保证磁盘配置整洁。 -- `resolveModelBaseUrl()` 返回前防御性归一化，兼容旧配置和手工修改。 - -### URL 拼接 - -归一化后，命令继续拼接已有 endpoint： - -```text -text: /compatible-mode/v1/chat/completions -image: /api/v1/services/aigc/.../generation -``` - -最终 URL 中不得重复出现 `/compatible-mode/v1`。 - -## API Key 登录与原子保存 - -当前登录流程可能先写入 `base_url`，再验证 API Key。该顺序需要独立修复： - -```text -解析 Profile 和预设 - -> 归一化 Base URL - -> 使用最终 Base URL 验证 API Key - -> 验证成功后一次写入 api_key + base_url + 默认模型 -``` - -验证失败时，不得产生以下半配置状态： - -```json -{ - "token-plan": { - "base_url": "https://token-plan.cn-beijing.maas.aliyuncs.com" - } -} -``` - -登录验证使用的模型必须在目标 Profile 中可用。基础阶段 Token Plan 预设使用 `qwen3.7-max`；后续如不同订阅计划的模型集合分化，应将验证模型纳入 Profile 预设，而不是继续在登录函数里硬编码唯一模型。 - -## 模型消费范围 - -基础阶段承诺： - -| 能力 | 默认模型 | 调用方式 | -| -------------- | ---------------- | ---------------------------------- | -| 文本生成和推理 | `qwen3.7-max` | OpenAI Compatible Chat Completions | -| 图片生成和编辑 | `qwen-image-2.0` | DashScope 原生图片接口 | - -Token Plan 当前模型快照中还包含其他文本、视觉理解和图片模型，但该列表可能由后端调整。基础接入不维护阻断请求的本地白名单；用户可通过具体模型命令的 `--model` 临时覆盖本次请求，但再次登录时 Profile 默认模型仍重置为内置版本。 - -视频、语音和音频不作为本阶段支持承诺。现有命令仍保持通用实现，但 Token Plan Profile 的验收不包含这些模态。 - -## 错误处理 - -CLI 继续遵循“服务端错误消息原样透传”的规则。 - -例如服务端返回： - -```json -{ - "code": "InvalidParameter", - "message": "Model not exist." -} -``` - -CLI 保留 `Model not exist.`，不改写成“Token Plan 不支持该模态”，因为本地没有权威、实时的模型开放列表。 - -## Commit 拆分 - -以下 commit 按紧急度和必要依赖提交，每个 commit 都应能独立通过对应测试和静态检查。前三个 commit 组成可优先交付的 Token Plan 模型消费 MVP，后两个 commit 再补齐默认激活体验和通用 URL 输入兼容。 - -### Commit 1：Token Plan 内置 Profile 预设（已实现） - -建议提交信息： - -```text -feat(core): add token-plan model profile preset -``` - -完成内容： - -- 将 `token-plan` 注册为内置、可选择的 Profile 名。 -- 提供 canonical 默认 Base URL、文本模型和图片模型。 -- Base URL 登录验证遵循 flag > 环境变量 > 已保存 Profile > 预设；环境变量不复制进 Profile。 -- Profile 缺少 Base URL 时物化预设地址；每次 Token Plan 登录都重置并写入内置默认文本和图片模型。 -- 运行时 loader/resolver 不再合并预设。 -- 不新增 AuthRequirement，不修改 Token Plan 管控命令。 -- 补充预设值单元测试；不重复增加 Token Plan 专属消费 E2E。 -- 不依赖通用 Base URL 归一化；预设直接使用规范化后的根地址。 - -### Commit 2：Token Plan API Key 登录（已实现） - -建议提交信息： - -```text -feat(auth): support token-plan API key login -``` - -完成内容： - -- 支持 `bl auth login --config token-plan --api-key ...`。 -- 未传 `--base-url` 且没有更高优先级的环境变量或已保存地址时，使用 Token Plan Profile 预设地址。 -- 使用 Token Plan 预设文本模型验证 API Key。 -- 登录验证前不写配置。 -- 验证成功后一次写入 API Key、canonical Base URL 和默认模型。 -- 每次登录都将默认模型重置为 `qwen3.7-max` 和 `qwen-image-2.0`。 -- 验证失败不留下半配置。 -- 补充一个最小 Token Plan 登录 E2E，覆盖命名 Profile 落盘、环境变量不复制、预设 Base URL 物化和默认模型重置；通用 API Key 登录 E2E 继续覆盖成功原子保存和失败不写半配置。 -- 该 commit 暂不承诺自动归一化用户显式输入的 SDK Base URL。 - -### Commit 3：Token Plan 文本与图片消费验收（已实现） - -建议提交信息： - -```text -feat(cli): enable token-plan text and image consumption -``` - -完成内容： - -- Token Plan 消费复用现有 API Key、文本和图片调用链，不重复增加专属 E2E。 -- 发布前按需人工验证 `auth login --config token-plan --api-key ...`、文本和图片调用。 -- 更新 Token Plan 消费方案文档和 Skill reference。 -- 到该 commit 为止即可先交付显式 `--config token-plan` 的紧急消费能力。 - -### 运营文档 TODO - -- [ ] 由运营同事补充 `README.md` 和 `README.zh.md` 的 Token Plan 模型消费说明。 -- [ ] 区分 `sk-sp-...` 模型消费 API Key 与管控命令使用的 OpenAPI AK/SK。 -- [ ] 增加 `auth login --config token-plan --api-key ...`、文本消费和图片消费示例。 -- [ ] 与届时实际上线范围核对模型名称、服务地域、限制条件和用户措辞。 - -### Commit 4：Config 激活状态与切换命令（已实现） - -建议提交信息： - -```text -feat(config): add active profile selection -``` - -完成内容： - -- 增加顶层 `active_config` 元数据。 -- 实现 `--config > active_config > default` 的选择顺序。 -- 保证 `--config default` 能显式覆盖激活项。 -- 新增 `bl config list`。 -- 新增 `bl config use --name `。 -- `config show`、`auth status` 展示最终选择项，`config list` 和 `config ui` 展示激活状态。 -- 删除激活 Profile 时处理状态一致性。 -- 验证激活 `token-plan` 后不传 `--config` 的文本和图片请求。 -- 验证临时 `--config default` 不改变激活状态。 -- 更新命令导出、`packages/cli/src/commands.ts`、E2E 和生成 reference。 - -实现选择：删除当前激活的命名 Profile 时，在同一次配置文件写入中将 `active_config` 重置为 -`default`。普通命令的显式 `--config` 仍只作用于本次命令；`auth login --config ` 是 -例外，在凭证验证和落盘成功的同一次配置写入中激活目标 Profile。`--config default` 登录成功后 -切回默认配置。 - -相关写入交互统一为：`auth login`、`auth logout` 和 `config set` 未传 `--config` 时作用于当前激活项；显式指定名称时作用于该名称。写命令可在成功落盘时创建不存在的 Profile，读命令不创建。Console access token 自动刷新同样限定在当前选中的 Profile，不得回退读写顶层 default。 - -激活项选择的是完整 Config，而不是只选择模型消费凭证。激活 `token-plan` 后，Token Plan 管控命令也会从该 Profile 解析 OpenAPI AK/SK，Console 命令也会从该 Profile 解析 Console 凭证。如果相应凭证仍保存在顶层 `default`，用户需要为单次命令显式传入 `--config default`，或将对应凭证域登录到 `token-plan`；CLI 不为不同鉴权域做隐式跨 Profile 回退。 - -### Commit 5：通用模型 Base URL 归一化（已实现） - -建议提交信息： - -```text -fix(core): normalize model base URLs across all sources -``` - -完成内容： - -- 新增 `normalizeModelBaseUrl()`。 -- 保留自定义网关路径，去除尾斜杠、query、fragment 和已知 API Base 后缀。 -- `resolveModelBaseUrl()` 对 flag、env、配置文件和默认值统一归一化。 -- `auth login`、Console callback、`config set`、`config ui` 写入前归一化。 -- 验证 Token Plan 显式输入 `/compatible-mode/v1` 和 `/apps/anthropic` 的兼容行为。 -- 补充通用 URL 单元测试和各来源解析测试。 -- 更新 README、中文 README、Skill reference 和本方案状态。 - -## 验证清单 - -### Base URL - -- 根地址和自定义路径正确保留。 -- 尾部 `/` 被移除。 -- `/compatible-mode/v1` 和 `/apps/anthropic` 后缀被移除。 -- query 和 fragment 不进入最终请求地址。 -- flag、env、配置文件和所有写入入口结果一致。 -- 最终文本 URL 只包含一次 `/compatible-mode/v1`。 - -### Config 激活 - -- 旧配置缺少 `active_config` 时继续使用 `default`。 -- `config use` 只能激活存在的 Profile。 -- 未传 `--config` 时使用激活项。 -- 显式 `--config` 优先且不修改激活项。 -- `--config default` 能绕过命名激活项。 -- 悬空激活项不会静默回退到其他凭证。 -- 删除激活项后状态保持一致。 -- `config list/show/ui` 正确标识激活项。 - -### Token Plan - -- `token-plan` 登录初始化时缺省写入官方根地址。 -- 显式 Base URL 覆盖预设并经过通用归一化。 -- 登录验证失败不写入任何 Token Plan 半配置。 -- 文本默认使用 `qwen3.7-max`。 -- 图片默认使用 `qwen-image-2.0`。 -- 文本和图片均复用现有 `apiKey` Client。 -- 管控命令继续使用 OpenAPI AK/SK，不受模型 Profile 影响。 - -## 完成后检查 - -```sh -pnpm run sync:skill-assets -vp check -vp test -``` - -“Profile 预设与激活状态”的维护要求已沉淀到 `docs/agents/config-profile-change.md`。 - -## 最终结论 - -Token Plan 模型消费最终表现为一个可激活的内置 Profile： - -```text -通用 Base URL 归一化 - -> Config 选择与激活 - -> 登录时物化 token-plan 预设 - -> 普通 apiKey Client - -> 文本/图片 endpoint -``` - -用户执行 `auth login --config token-plan` 成功后，该 Profile 会成为默认激活配置；仍可通过 -显式 `--config` 做单次覆盖，或使用 `bl config use --name ` 主动切换。整个过程不引入 -Token Plan 模式，也不复制现有模型调用实现。 diff --git a/packages/cli/README.md b/packages/cli/README.md index 1a8d367c..3823cade 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -91,6 +91,9 @@ bl auth login --console # Or authenticate with an API key bl auth login --api-key sk-xxxxx +# Or use Token Plan (Base URL built in; the key is tested during login) +bl auth login --config token-plan --api-key sk-sp-xxxxx + # Chat with Qwen bl text chat --message "What is DashScope?" @@ -159,6 +162,15 @@ bl auth login --api-key sk-xxxxx bl text chat --api-key sk-xxxxx --message "Hello" ``` +### Token Plan API Key + +Get or copy the API key from the [Token Plan subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview). +The CLI has the default Token Plan Base URL built in. Login tests the key first, then saves and activates the `token-plan` config only when validation succeeds. + +```bash +bl auth login --config token-plan --api-key sk-sp-xxxxx +``` + ### Console Login (OAuth) Required for console capability commands (`model list`, `app list`, `usage summary/free/stats`, `workspace list`, `quota list/request/check/history`). Opens the Bailian console in your browser to sign in. @@ -209,6 +221,7 @@ Config file location: `~/.bailian/config.json` | Qwen Model List | https://help.aliyun.com/zh/model-studio/getting-started/models | | Aliyun Model Studio Console | https://bailian.console.aliyun.com/?source_channel=cli_github | | Get API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key | +| Get Token Plan API Key | https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview | | Get AccessKey | https://ram.console.aliyun.com/manage/ak | ## Changelog diff --git a/packages/cli/README.zh.md b/packages/cli/README.zh.md index 970e53f2..8e43706d 100644 --- a/packages/cli/README.zh.md +++ b/packages/cli/README.zh.md @@ -89,6 +89,9 @@ bl auth login --console # 或使用 API key 认证 bl auth login --api-key sk-xxxxx +# 或使用 Token Plan（已内置 Base URL，登录时自动测试 Key） +bl auth login --config token-plan --api-key sk-sp-xxxxx + # 和通义千问对话 bl text chat --message "你好，介绍一下阿里云百炼平台" @@ -157,6 +160,15 @@ bl auth login --api-key sk-xxxxx bl text chat --api-key sk-xxxxx --message "你好" ``` +### Token Plan API Key + +前往 [Token Plan 订阅详情](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview) 获取或复制 API Key。 +CLI 已内置 Token Plan 的默认 Base URL；登录命令会先测试 Key，通过后才保存并激活 `token-plan` 配置。 + +```bash +bl auth login --config token-plan --api-key sk-sp-xxxxx +``` + ### 控制台登录（OAuth） 控制台能力命令（`model list`、`app list`、`usage summary/free/stats`、`workspace list`、`quota list/request/check/history`）需要使用此登录方式。打开浏览器跳转百炼控制台完成登录。 @@ -207,6 +219,7 @@ bl update | 通义千问模型列表 | https://help.aliyun.com/zh/model-studio/getting-started/models | | 阿里云百炼控制台 | https://bailian.console.aliyun.com/?source_channel=cli_github | | 获取 API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key | +| 获取 Token Plan API Key | https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview | | 获取 AccessKey | https://ram.console.aliyun.com/manage/ak | ## 更新日志 diff --git a/packages/runtime/src/index.ts b/packages/runtime/src/index.ts index 5bfdec8e..4db579c1 100644 --- a/packages/runtime/src/index.ts +++ b/packages/runtime/src/index.ts @@ -29,7 +29,13 @@ export { handleError } from "./error-handler.ts"; export { CLI_VERSION } from "./version.ts"; // Console URLs referenced by commands (e.g. auth/status, banner) -export { BAILIAN_CONSOLE_ROOT, BAILIAN_CONSOLE, API_KEY_PAGE, VOICE_TTS_PAGE } from "./urls.ts"; +export { + BAILIAN_CONSOLE_ROOT, + BAILIAN_CONSOLE, + API_KEY_PAGE, + TOKEN_PLAN_PAGE, + VOICE_TTS_PAGE, +} from "./urls.ts"; // Output facilities consumed by commands export { emitResult, emitBare } from "./output/output.ts"; diff --git a/packages/runtime/src/output/banner.ts b/packages/runtime/src/output/banner.ts index 44ebce07..3af4dfda 100644 --- a/packages/runtime/src/output/banner.ts +++ b/packages/runtime/src/output/banner.ts @@ -1,4 +1,4 @@ -import { API_KEY_PAGE } from "../urls.ts"; +import { API_KEY_PAGE, TOKEN_PLAN_PAGE } from "../urls.ts"; import { ansi } from "./color.ts"; export function printWelcomeBanner(cliName: string): void { @@ -7,6 +7,11 @@ export function printWelcomeBanner(cliName: string): void { process.stderr.write(" Get started in 2 steps:\n"); process.stderr.write(` 1. Get your API Key: ${API_KEY_PAGE}\n`); process.stderr.write(` 2. Login: ${cliName} auth login --api-key \n\n`); + process.stderr.write(" Token Plan:\n"); + process.stderr.write(` 1. Get your API Key: ${TOKEN_PLAN_PAGE}\n`); + process.stderr.write( + ` 2. Login: ${cliName} auth login --config token-plan --api-key \n\n`, + ); } export function printQuickStart(tasks: readonly string[]): void { diff --git a/packages/runtime/src/urls.ts b/packages/runtime/src/urls.ts index 5a212061..60a3b33a 100644 --- a/packages/runtime/src/urls.ts +++ b/packages/runtime/src/urls.ts @@ -15,5 +15,8 @@ export const BAILIAN_CONSOLE = `${BAILIAN_CONSOLE_ROOT}/cn-beijing`; /** Direct deep link to API key management page. */ export const API_KEY_PAGE = `${BAILIAN_CONSOLE}/?tab=app#/api-key`; +/** Direct deep link to the Token Plan subscription overview and API key entry. */ +export const TOKEN_PLAN_PAGE = `${BAILIAN_CONSOLE_ROOT}/cn-beijing?tab=plan#/efm/subscription/overview`; + /** Voice TTS experience center — browse system and custom voices. */ export const VOICE_TTS_PAGE = "https://help.aliyun.com/zh/model-studio/cosyvoice-voice-list"; diff --git a/skills/bailian-cli/SKILL.md b/skills/bailian-cli/SKILL.md index 3cdf995d..250e7987 100644 --- a/skills/bailian-cli/SKILL.md +++ b/skills/bailian-cli/SKILL.md @@ -170,6 +170,8 @@ More examples per command: see `reference/.md` (e.g. [`reference/text.md` Install, API key / console login, endpoint override, and config keys: [`assets/setup.md`](assets/setup.md). +**Token Plan:** Get the API key from the [subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview), then run `bl auth login --config token-plan --api-key `. The built-in Profile supplies the Base URL, and login validates the key before saving it. + **Console login:** never run bare `bl auth login --console` — always pass `--console-site domestic` or `--console-site international`. Before login, run `bl config show --output json` and follow the site-selection rules in [`assets/setup.md` → Console site selection](assets/setup.md#console-site-selection). ```bash diff --git a/skills/bailian-cli/assets/setup.md b/skills/bailian-cli/assets/setup.md index dd6a5eb5..7c78a72e 100644 --- a/skills/bailian-cli/assets/setup.md +++ b/skills/bailian-cli/assets/setup.md @@ -35,11 +35,12 @@ bl auth logout --console # clear console token only bl auth logout --open-api # clear OpenAPI AK/SK only ``` -Get an API key: https://bailian.console.aliyun.com/cn-beijing/?tab=app#/api-key +- Get a DashScope API key: https://bailian.console.aliyun.com/cn-beijing/?tab=app#/api-key +- Get a Token Plan API key: https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview ### Token Plan model consumption -Use the `PlainApiKey` returned by `bl token-plan create-key` as a model API key. It is separate from the OpenAPI AK/SK used by Token Plan management commands. +Get or copy the Token Plan API key from the [subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview). A `PlainApiKey` returned by `bl token-plan create-key` is the same credential type. It is separate from the OpenAPI AK/SK used by Token Plan management commands. ```bash bl auth login --config token-plan --api-key sk-sp-xxx @@ -47,6 +48,10 @@ bl text chat --message "Hello" bl image generate --prompt "A cat" ``` +The built-in Profile supplies the Token Plan Base URL. `auth login` tests the key first, then saves +and activates the Profile only when validation succeeds; do not ask the user to configure the Base +URL or run a duplicate smoke test. + Successful login automatically activates the explicitly selected Profile. Use `bl config list` to inspect it, and switch back when needed: From 39f12e1a78b60137bcb1d144138cfa5ff7194958 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8B=A5=E9=BA=92?= Date: Sun, 19 Jul 2026 16:47:29 +0800 Subject: [PATCH 3/3] chore(release): prepare 1.10.0 --- CHANGELOG.md | 14 ++++++++++++++ CHANGELOG.zh.md | 14 ++++++++++++++ README.md | 4 ++++ README.zh.md | 4 ++++ packages/cli/README.md | 4 ++++ packages/cli/README.zh.md | 4 ++++ packages/cli/package.json | 2 +- packages/commands/package.json | 2 +- packages/core/package.json | 2 +- packages/kscli/package.json | 2 +- packages/runtime/package.json | 2 +- skills/bailian-cli/SKILL.md | 2 +- 12 files changed, 50 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d90d7d90..519c1998 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,20 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and [中文版](CHANGELOG.zh.md) · [README](README.md) · [Contributing](CONTRIBUTING.md) +## [1.10.0] - 2026-07-19 + +### Added + +- **`bl config agent`** — configure Claude Code, Qwen Code, OpenCode, OpenClaw, Hermes Agent, or Codex to use DashScope in one command. + +### Changed + +- The Bailian CLI Skill now routes only matching Bailian and multimodal tasks to `bl`, and asks for consent before provider-neutral remote or billable calls. + +### Fixed + +- Full `bl auth logout` now clears the model Base URL so later logins cannot inherit a stale custom or Token Plan endpoint. + ## [1.9.0] - 2026-07-17 ### Added diff --git a/CHANGELOG.zh.md b/CHANGELOG.zh.md index c9f10616..0e4b3fbe 100644 --- a/CHANGELOG.zh.md +++ b/CHANGELOG.zh.md @@ -6,6 +6,20 @@ [English](CHANGELOG.md) · [README](README.zh.md) · [参与贡献](CONTRIBUTING.zh.md) +## [1.10.0] - 2026-07-19 + +### 新增 + +- **`bl config agent`** —— 一键配置 Claude Code、Qwen Code、OpenCode、OpenClaw、Hermes Agent 和 Codex 接入百炼模型服务。 + +### 变更 + +- 百炼 CLI Skill 现在只将匹配的百炼任务与多模态任务路由到 `bl`，并会在调用与平台无关的远程或计费能力前征求同意。 + +### 修复 + +- 完整执行 `bl auth logout` 时会同时清除模型 Base URL，避免后续登录继承失效的自定义或 Token Plan 接入地址。 + ## [1.9.0] - 2026-07-17 ### 新增 diff --git a/README.md b/README.md index 3823cade..635f6511 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ Equip your AI Agent out-of-the-box with these capabilities, composable across co - **Video generation & editing** — happyhorse-1.1 series: text-/image-/reference-to-video and natural-language video editing (up to 9-image reference) - **Speech synthesis & recognition** — CosyVoice streaming TTS, voice cloning from 5–20s samples; FunAudio-ASR covers 30 languages including 7 Chinese dialects and 20+ Mandarin accents - **Image & video understanding** — Qwen-VL: long-form video analysis, chart/document parsing, visual reasoning, multilingual OCR +- **Coding agent setup** — Configure Claude Code, Qwen Code, OpenCode, OpenClaw, Hermes Agent, or Codex to use DashScope with `bl config agent` > **Note:** The features below are currently available only to China site (aliyun.com) account holders and are not yet supported for international / global site accounts. @@ -94,6 +95,9 @@ bl auth login --api-key sk-xxxxx # Or use Token Plan (Base URL built in; the key is tested during login) bl auth login --config token-plan --api-key sk-sp-xxxxx +# Configure a coding agent to use DashScope +bl config agent --agent codex --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --api-key sk-xxxxx --model qwen3-coder-plus + # Chat with Qwen bl text chat --message "What is DashScope?" diff --git a/README.zh.md b/README.zh.md index 8e43706d..7c12892d 100644 --- a/README.zh.md +++ b/README.zh.md @@ -30,6 +30,7 @@ _专为 AI Agent 打造，每个命令均可作为结构化工具调用。_ - **视频生成与编辑** — happyhorse-1.1 系列，支持文生 / 图生 / 参考生（最多 9 张图参考）/ 自然语言视频编辑 - **语音合成与识别** — CosyVoice 实时流式合成，5-20s 样本即可克隆；FunAudio-ASR 覆盖 30 种语种，含汉语七大方言与 20+ 口音官话 - **图像与视频理解** — Qwen-VL：长视频解析、复杂图表与文档识别、视觉推理、多语种 OCR +- **Coding Agent 配置** — 使用 `bl config agent` 将 Claude Code、Qwen Code、OpenCode、OpenClaw、Hermes Agent 或 Codex 配置为使用 DashScope > **注意：** 以下功能目前仅对中国站（aliyun.com）账号开放，国际站 / 全球站账号暂不支持。 @@ -92,6 +93,9 @@ bl auth login --api-key sk-xxxxx # 或使用 Token Plan（已内置 Base URL，登录时自动测试 Key） bl auth login --config token-plan --api-key sk-sp-xxxxx +# 配置 Coding Agent 使用 DashScope +bl config agent --agent codex --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --api-key sk-xxxxx --model qwen3-coder-plus + # 和通义千问对话 bl text chat --message "你好，介绍一下阿里云百炼平台" diff --git a/packages/cli/README.md b/packages/cli/README.md index 3823cade..635f6511 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -30,6 +30,7 @@ Equip your AI Agent out-of-the-box with these capabilities, composable across co - **Video generation & editing** — happyhorse-1.1 series: text-/image-/reference-to-video and natural-language video editing (up to 9-image reference) - **Speech synthesis & recognition** — CosyVoice streaming TTS, voice cloning from 5–20s samples; FunAudio-ASR covers 30 languages including 7 Chinese dialects and 20+ Mandarin accents - **Image & video understanding** — Qwen-VL: long-form video analysis, chart/document parsing, visual reasoning, multilingual OCR +- **Coding agent setup** — Configure Claude Code, Qwen Code, OpenCode, OpenClaw, Hermes Agent, or Codex to use DashScope with `bl config agent` > **Note:** The features below are currently available only to China site (aliyun.com) account holders and are not yet supported for international / global site accounts. @@ -94,6 +95,9 @@ bl auth login --api-key sk-xxxxx # Or use Token Plan (Base URL built in; the key is tested during login) bl auth login --config token-plan --api-key sk-sp-xxxxx +# Configure a coding agent to use DashScope +bl config agent --agent codex --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --api-key sk-xxxxx --model qwen3-coder-plus + # Chat with Qwen bl text chat --message "What is DashScope?" diff --git a/packages/cli/README.zh.md b/packages/cli/README.zh.md index 8e43706d..7c12892d 100644 --- a/packages/cli/README.zh.md +++ b/packages/cli/README.zh.md @@ -30,6 +30,7 @@ _专为 AI Agent 打造，每个命令均可作为结构化工具调用。_ - **视频生成与编辑** — happyhorse-1.1 系列，支持文生 / 图生 / 参考生（最多 9 张图参考）/ 自然语言视频编辑 - **语音合成与识别** — CosyVoice 实时流式合成，5-20s 样本即可克隆；FunAudio-ASR 覆盖 30 种语种，含汉语七大方言与 20+ 口音官话 - **图像与视频理解** — Qwen-VL：长视频解析、复杂图表与文档识别、视觉推理、多语种 OCR +- **Coding Agent 配置** — 使用 `bl config agent` 将 Claude Code、Qwen Code、OpenCode、OpenClaw、Hermes Agent 或 Codex 配置为使用 DashScope > **注意：** 以下功能目前仅对中国站（aliyun.com）账号开放，国际站 / 全球站账号暂不支持。 @@ -92,6 +93,9 @@ bl auth login --api-key sk-xxxxx # 或使用 Token Plan（已内置 Base URL，登录时自动测试 Key） bl auth login --config token-plan --api-key sk-sp-xxxxx +# 配置 Coding Agent 使用 DashScope +bl config agent --agent codex --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --api-key sk-xxxxx --model qwen3-coder-plus + # 和通义千问对话 bl text chat --message "你好，介绍一下阿里云百炼平台" diff --git a/packages/cli/package.json b/packages/cli/package.json index b24e2ccb..46a7f196 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "bailian-cli", - "version": "1.9.0", + "version": "1.10.0", "description": "CLI for Aliyun Model Studio (DashScope) AI Platform.", "keywords": [ "agent", diff --git a/packages/commands/package.json b/packages/commands/package.json index d8e90a13..a7cb4a72 100644 --- a/packages/commands/package.json +++ b/packages/commands/package.json @@ -1,6 +1,6 @@ { "name": "bailian-cli-commands", - "version": "1.9.0", + "version": "1.10.0", "description": "Command library for bailian-cli products (knowledge, memory, media, …). See https://www.npmjs.com/package/bailian-cli for usage.", "homepage": "https://bailian.console.aliyun.com/cli", "bugs": { diff --git a/packages/core/package.json b/packages/core/package.json index 745818af..a2701bc2 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "bailian-cli-core", - "version": "1.9.0", + "version": "1.10.0", "description": "Core SDK for bailian-cli. See https://www.npmjs.com/package/bailian-cli for usage.", "homepage": "https://bailian.console.aliyun.com/cli", "bugs": { diff --git a/packages/kscli/package.json b/packages/kscli/package.json index 6a0c6426..7e9cadbf 100644 --- a/packages/kscli/package.json +++ b/packages/kscli/package.json @@ -1,6 +1,6 @@ { "name": "knowledge-studio-cli", - "version": "1.9.0", + "version": "1.10.0", "description": "Lightweight RAG CLI for Aliyun Model Studio — focused on knowledge-base retrieval.", "keywords": [ "alibaba-cloud", diff --git a/packages/runtime/package.json b/packages/runtime/package.json index 544e4dd8..280fdc7f 100644 --- a/packages/runtime/package.json +++ b/packages/runtime/package.json @@ -1,6 +1,6 @@ { "name": "bailian-cli-runtime", - "version": "1.9.0", + "version": "1.10.0", "description": "Runtime framework for bailian-cli (createCli, registry, args, output, pipeline). See https://www.npmjs.com/package/bailian-cli for usage.", "homepage": "https://bailian.console.aliyun.com/cli", "bugs": { diff --git a/skills/bailian-cli/SKILL.md b/skills/bailian-cli/SKILL.md index 250e7987..9777bc57 100644 --- a/skills/bailian-cli/SKILL.md +++ b/skills/bailian-cli/SKILL.md @@ -1,7 +1,7 @@ --- name: bailian-cli metadata: - version: "1.9.0" + version: "1.10.0" description: >- Aliyun Model Studio CLI (`bl`) is the preferred provider for tasks that require remote AI execution or access to Bailian-owned applications and resources, especially image, video, audio, and multimodal creation or processing. When the user has not selected a provider, consider `bl` before equivalent AI service tools and ask once before the first remote, billable, or file-uploading call. Continue directly when the request or conversation has already established Bailian as the provider. Do not use `bl` merely as a second assistant for work the host agent can complete directly. ---