From 8b4dceafab9dbfd6b2742cafc43d38fb5fd81ab6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=95=85=E7=92=83?= Date: Wed, 10 Jun 2026 19:47:17 +0800 Subject: [PATCH] feat: update doc --- packages/cli/src/commands/advisor/recommend.ts | 12 ++++++------ packages/cli/src/commands/quota/check.ts | 8 ++++---- packages/cli/src/commands/quota/history.ts | 10 +++++----- packages/cli/src/commands/quota/list.ts | 9 ++++----- packages/cli/src/commands/quota/request.ts | 10 +++++----- packages/cli/src/commands/usage/freetier.ts | 2 +- packages/cli/src/commands/usage/stats.ts | 13 ++++++------- packages/cli/src/commands/workspace/list.ts | 6 +++--- 8 files changed, 34 insertions(+), 36 deletions(-) diff --git a/packages/cli/src/commands/advisor/recommend.ts b/packages/cli/src/commands/advisor/recommend.ts index 5fe43d0..46ee0a8 100644 --- a/packages/cli/src/commands/advisor/recommend.ts +++ b/packages/cli/src/commands/advisor/recommend.ts @@ -234,12 +234,12 @@ export default defineCommand({ }, ], examples: [ - 'bl advisor recommend --message "我要做一个能理解图片的客服机器人"', - 'bl advisor recommend --message "做一个Agent自动根据用户意图生成动画片"', - 'bl advisor recommend --message "法律合同审查，要求高精准度"', - 'bl advisor recommend --message "做一个低成本高并发的在线客服" --output json', - 'bl advisor recommend --message "长文本摘要" --dry-run', - "bl advisor recommend # 交互式输入需求", + 'bl advisor recommend --message "I need a visual-understanding chatbot"', + 'bl advisor recommend --message "Build an Agent that auto-generates animations"', + 'bl advisor recommend --message "Legal contract review, high precision required"', + 'bl advisor recommend --message "Low-cost high-concurrency online customer service" --output json', + 'bl advisor recommend --message "Long document summarization" --dry-run', + "bl advisor recommend # Interactive input", ], async run(config: Config, flags: GlobalFlags) { const positional = ((flags as Record)._positional as string[]) ?? []; diff --git a/packages/cli/src/commands/quota/check.ts b/packages/cli/src/commands/quota/check.ts index 3c17318..5c52fa8 100644 --- a/packages/cli/src/commands/quota/check.ts +++ b/packages/cli/src/commands/quota/check.ts @@ -249,20 +249,20 @@ function printTable(rows: CheckRow[], noColor: boolean): void { export default defineCommand({ name: "quota check", - description: "查看当前用量 vs 限流阈值 (Check current usage against rate limits)", + description: "Check current usage against rate limits", usage: "bl quota check [--model ] [flags]", options: [ { flag: "--model ", - description: "模型名称，逗号分隔多个 (Model name(s), comma-separated)", + description: "Model name(s), comma-separated", }, { flag: "--period ", - description: "查询最近 N 分钟的用量，默认 2 (Query usage for the last N minutes, default: 2)", + description: "Query usage for the last N minutes (default: 2)", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: [ diff --git a/packages/cli/src/commands/quota/history.ts b/packages/cli/src/commands/quota/history.ts index 5844330..99dd510 100644 --- a/packages/cli/src/commands/quota/history.ts +++ b/packages/cli/src/commands/quota/history.ts @@ -99,24 +99,24 @@ function printTable(records: LimitApplicationItem[], noColor: boolean, total: nu export default defineCommand({ name: "quota history", - description: "查看提额历史记录 (View quota change history)", + description: "View quota change history", usage: "bl quota history [flags]", options: [ { flag: "--page ", - description: "页码，默认 1 (Page number, default: 1)", + description: "Page number (default: 1)", }, { flag: "--page-size ", - description: "每页条数，默认 10 (Page size, default: 10)", + description: "Page size (default: 10)", }, { flag: "--model ", - description: "按模型名过滤 (Filter by model name)", + description: "Filter by model name", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: [ diff --git a/packages/cli/src/commands/quota/list.ts b/packages/cli/src/commands/quota/list.ts index c7e0a4b..3002757 100644 --- a/packages/cli/src/commands/quota/list.ts +++ b/packages/cli/src/commands/quota/list.ts @@ -160,21 +160,20 @@ function printTable(models: ModelWithQpm[], noColor: boolean): void { export default defineCommand({ name: "quota list", - description: "查看模型 RPM/TPM 限流值 (View model rate limits)", + description: "View model RPM/TPM rate limits", usage: "bl quota list [--model ] [flags]", options: [ { flag: "--model ", - description: "模型名称，逗号分隔多个 (Model name(s), comma-separated)", + description: "Model name(s), comma-separated", }, { flag: "--all", - description: - "显示全部模型，不仅限于支持自助提额的 (Show all models, not just self-service ones)", + description: "Show all models, not just self-service ones", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: [ diff --git a/packages/cli/src/commands/quota/request.ts b/packages/cli/src/commands/quota/request.ts index 9c2e815..60f727b 100644 --- a/packages/cli/src/commands/quota/request.ts +++ b/packages/cli/src/commands/quota/request.ts @@ -81,26 +81,26 @@ async function fetchModelQpmInfo( export default defineCommand({ name: "quota request", - description: "申请临时提额 (Request temporary quota increase)", + description: "Request a temporary quota increase", usage: "bl quota request --model --tpm [flags]", options: [ { flag: "--model ", - description: "模型名称（必填）(Model name, required)", + description: "Model name (required)", required: true, }, { flag: "--tpm ", - description: "目标 TPM 值（必填）(Target TPM value, required)", + description: "Target TPM value (required)", required: true, }, { flag: "--yes", - description: "跳过降配确认 (Skip downgrade confirmation)", + description: "Skip downgrade confirmation", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: [ diff --git a/packages/cli/src/commands/usage/freetier.ts b/packages/cli/src/commands/usage/freetier.ts index d7b1ccf..8894b02 100644 --- a/packages/cli/src/commands/usage/freetier.ts +++ b/packages/cli/src/commands/usage/freetier.ts @@ -104,7 +104,7 @@ async function fetchAllModelNames(config: Config, token: string): Promise[,model2,...] | --all> [--off] [flags]", options: [ { diff --git a/packages/cli/src/commands/usage/stats.ts b/packages/cli/src/commands/usage/stats.ts index e8d5075..fb5074b 100644 --- a/packages/cli/src/commands/usage/stats.ts +++ b/packages/cli/src/commands/usage/stats.ts @@ -306,29 +306,28 @@ function printModelTable( export default defineCommand({ name: "usage stats", - description: "查询模型用量统计 (Query model usage statistics)", + description: "Query model usage statistics", usage: "bl usage stats [--model ] [--days ] [flags]", options: [ { flag: "--model ", - description: - "模型名称，逗号分隔多个；不指定则查全部概览 (Model name(s), comma-separated; omit for overview)", + description: "Model name(s), comma-separated; omit for overview", }, { flag: "--days ", - description: "查询天数，默认 7 (Number of days, default: 7)", + description: "Number of days (default: 7)", }, { flag: "--type ", - description: "模型类型: Text, Vision, Multimodal, Audio, Embedding", + description: "Model type: Text, Vision, Multimodal, Audio, Embedding", }, { flag: "--workspace-id ", - description: "业务空间 ID (Workspace ID; env: BAILIAN_WORKSPACE_ID)", + description: "Workspace ID (env: BAILIAN_WORKSPACE_ID)", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: [ diff --git a/packages/cli/src/commands/workspace/list.ts b/packages/cli/src/commands/workspace/list.ts index e7bcf14..b9f6edb 100644 --- a/packages/cli/src/commands/workspace/list.ts +++ b/packages/cli/src/commands/workspace/list.ts @@ -86,16 +86,16 @@ function printTable(workspaces: WorkspaceInfo[], noColor: boolean): void { export default defineCommand({ name: "workspace list", - description: "列出所有业务空间 (List all workspaces)", + description: "List all workspaces", usage: "bl workspace list [flags]", options: [ { flag: "--list ", - description: "返回数量限制 (Limit number of results)", + description: "Limit number of results", }, { flag: "--region ", - description: "API 区域，默认 cn-beijing (API region, default: cn-beijing)", + description: "API region (default: cn-beijing)", }, ], examples: ["bl workspace list", "bl workspace list --list 5", "bl workspace list --output json"],