mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
fd96fd664c
The destructive --delete flag sat on "quota update", but the --yes high-risk confirmation guards command paths rather than individual flags. Promote it to its own "quota delete" command with a --yes guardrail, and reduce "quota update" to QPM/TPM updates only.
33 KiB
33 KiB
bailian-cli command reference
Auto-generated from
packages/cli/src/commands.ts. Do not edit by hand. Regenerate:pnpm --filter bailian-cli run generate:reference.
Command details are in sibling <group>.md files in this directory.
This index only covers groups owned by this skill. Other bl groups live in sibling bailian-* skills.
Use this index for the skill-scoped quick index and global flags.
Quick index
| Command | Authentication | Description | Detail |
|---|---|---|---|
bl advisor recommend |
API Key | Recommend the best models for your use case (intent analysis → candidate recall → LLM ranking) | advisor.md |
bl app call |
API Key | Call a Bailian application (agent or workflow) | app.md |
bl app list |
Console | List Bailian applications | app.md |
bl auth generate-access-token |
No Auth | Generate a CLI access token using OpenAPI AK/SK | auth.md |
bl auth login |
No Auth | Authenticate with API key, console browser login, or OpenAPI AK/SK (credentials can coexist) | auth.md |
bl auth logout |
No Auth | Clear stored credentials; full logout also clears the model Base URL | auth.md |
bl auth status |
No Auth | Show current authentication state | auth.md |
bl config agent |
No Auth | Configure a coding agent to use DashScope API | config.md |
bl config list |
No Auth | List config profiles and show the active profile | config.md |
bl config set |
No Auth | Set a config value | config.md |
bl config show |
No Auth | Display current configuration | config.md |
bl config ui |
No Auth | Open a local web UI to manage config profiles | config.md |
bl config use |
No Auth | Set the active config profile | config.md |
bl console call |
Console | Call a Bailian console API via the CLI gateway | console.md |
bl file upload |
API Key | Upload a local file to DashScope temporary storage (48h) | file.md |
bl knowledge category add |
API Key | Create a data-center category | knowledge.md |
bl knowledge category delete |
API Key | Delete a data-center category | knowledge.md |
bl knowledge category list |
API Key | List data-center categories | knowledge.md |
bl knowledge chat |
API Key | Chat with a Bailian knowledge base (RAG Q&A with streaming) | knowledge.md |
bl knowledge chunk add |
API Key | Add a chunk directly to a knowledge base | knowledge.md |
bl knowledge chunk delete |
API Key | Delete chunks from a knowledge base (irreversible) | knowledge.md |
bl knowledge chunk list |
API Key | List chunks in a knowledge base with content and status | knowledge.md |
bl knowledge chunk update |
API Key | Update chunk content or toggle its retrieval visibility | knowledge.md |
bl knowledge collection create |
API Key | Create a FILE data collection | knowledge.md |
bl knowledge collection get |
API Key | Show data collection details | knowledge.md |
bl knowledge create |
API Key | Create a knowledge base and import data-center files or categories | knowledge.md |
bl knowledge delete |
API Key | Delete a knowledge base with all its documents and chunks | knowledge.md |
bl knowledge doc delete |
API Key | Delete documents and their chunks from a knowledge base | knowledge.md |
bl knowledge doc import-oss |
API Key | Batch import files from an authorized OSS bucket into the data center | knowledge.md |
bl knowledge doc list |
API Key | List documents in a knowledge base with parse/index status | knowledge.md |
bl knowledge doc status |
API Key | Check knowledge base import job status | knowledge.md |
bl knowledge doc tag |
API Key | Batch update tags on data-center files | knowledge.md |
bl knowledge doc upload |
API Key | Upload local files or directories to the data center and optionally import into a knowledge base | knowledge.md |
bl knowledge file delete |
API Key | Permanently delete a file from the data center | knowledge.md |
bl knowledge file get |
API Key | Show data-center file details (size, MD5, tags, timestamps) | knowledge.md |
bl knowledge file list |
API Key | List files in a data-center category | knowledge.md |
bl knowledge info |
API Key | Show knowledge base configuration details | knowledge.md |
bl knowledge list |
API Key | List knowledge bases in the workspace | knowledge.md |
bl knowledge retrieve |
API Key | Retrieve from a Bailian knowledge base (deprecated, use search instead) |
knowledge.md |
bl knowledge search |
API Key | Search a Bailian knowledge base (RAG semantic retrieval) | knowledge.md |
bl knowledge service copy |
API Key | Copy a service into a new draft (name gets a copy_ prefix) | knowledge.md |
bl knowledge service create |
API Key | Create a retrieval / Q&A service (initial status: draft, version: beta) | knowledge.md |
bl knowledge service delete |
API Key | Delete a retrieval / Q&A service (soft delete, idempotent) | knowledge.md |
bl knowledge service deploy |
API Key | Publish the beta draft of a service as a new version | knowledge.md |
bl knowledge service get |
API Key | Show service (agent) details including per-version configuration | knowledge.md |
bl knowledge service list |
API Key | List retrieval / Q&A services (agents) in the workspace | knowledge.md |
bl knowledge service update |
API Key | Update service name, description or draft configuration | knowledge.md |
bl knowledge stats |
API Key | Show knowledge base storage and QPS monitoring data | knowledge.md |
bl knowledge update |
API Key | Update knowledge base name, description or rerank threshold | knowledge.md |
bl mcp call |
API Key | Call a tool on an MCP server (tools/call) | mcp.md |
bl mcp list |
Console | List MCP servers activated under your Bailian account | mcp.md |
bl mcp tools |
API Key | List tools exposed by an MCP server (tools/list) | mcp.md |
bl memory add |
API Key | Add memory from messages or custom content | memory.md |
bl memory delete |
API Key | Delete a memory node | memory.md |
bl memory list |
API Key | List memory nodes for a user | memory.md |
bl memory profile create |
API Key | Create a user profile schema for memory profiling | memory.md |
bl memory profile get |
API Key | Get user profile by schema ID and user ID | memory.md |
bl memory search |
API Key | Search memory nodes by query or messages | memory.md |
bl memory update |
API Key | Update a memory node content | memory.md |
bl model list |
No Auth | Browse model families or show detailed model info in the Bailian model marketplace | model.md |
bl permission grant |
API Key | Grant model permissions (inference / finetune / deploy) | permission.md |
bl permission list |
API Key | List model permissions (inference / fine-tune / deploy) in the workspace | permission.md |
bl permission revoke |
API Key | Revoke model permissions (inference / finetune / deploy) | permission.md |
bl pipeline run |
No Auth | Run a pipeline workflow definition | pipeline.md |
bl pipeline validate |
No Auth | Validate a pipeline definition without executing | pipeline.md |
bl plugin install |
No Auth | Install or upgrade an allowlisted Command Pack | plugin.md |
bl plugin link |
No Auth | Link an allowlisted local Command Pack for development | plugin.md |
bl plugin list |
No Auth | List installed Command Packs and their load status | plugin.md |
bl plugin remove |
No Auth | Remove an installed Command Pack | plugin.md |
bl quota check |
Console | Check current usage against rate limits | quota.md |
bl quota delete |
API Key | Clear all custom rate limits (QPM/TPM) for a model | quota.md |
bl quota history |
Console | View quota change history | quota.md |
bl quota list |
API Key | View model rate limits (QPM/TPM, account and workspace level) | quota.md |
bl quota update |
API Key | Update model rate limits (QPM/TPM) | quota.md |
bl search web |
API Key | Search the web using DashScope MCP WebSearch service | search.md |
bl skill add |
No Auth | Install skills from the Bailian skill registry into local agents | skill.md |
bl skill init |
No Auth | Install all bailian-* skills (one-shot bootstrap for new environments) | skill.md |
bl skill list |
No Auth | List registry skills and diff against local installs | skill.md |
bl skill remove |
No Auth | Remove locally installed skills (registry is untouched) | skill.md |
bl skill update |
No Auth | Update installed skills to the latest registry versions | skill.md |
bl text chat |
API Key | Send a text model request (OpenAI compatible, DashScope) | text.md |
bl token-plan add-member |
AK/SK | Add a member to a Token Plan organization | token-plan.md |
bl token-plan assign-seats |
AK/SK | Batch assign Token Plan seats to members | token-plan.md |
bl token-plan create-key |
AK/SK | Create a Token Plan API key for a seat | token-plan.md |
bl token-plan list-seats |
AK/SK | List Token Plan subscription seat details | token-plan.md |
bl update |
No Auth | Update the CLI to the latest or a specified version | update.md |
bl usage coding-plan |
Console | Show Coding Plan quota usage | usage.md |
bl usage free |
Console | Query free-tier quota for models (all models if --model is omitted) | usage.md |
bl usage freetier |
Console | Enable or disable auto-stop for free-tier models. Enables by default; use --off to disable | usage.md |
bl usage stats |
Console | Query model usage statistics | usage.md |
bl usage summary |
Console | Show a unified usage summary: free-tier quota and recent usage overview | usage.md |
bl usage token-plan |
Console | Show Token Plan quota usage | usage.md |
bl workspace init |
No Auth | Initialize Bailian workspace and activate postpaid services | workspace.md |
bl workspace list |
Console | List all workspaces | workspace.md |
By group
| Group | Commands | Reference |
|---|---|---|
advisor |
recommend |
advisor.md |
app |
call, list |
app.md |
auth |
generate-access-token, login, logout, status |
auth.md |
config |
agent, list, set, show, ui, use |
config.md |
console |
call |
console.md |
file |
upload |
file.md |
knowledge |
category add, category delete, category list, chat, chunk add, chunk delete, chunk list, chunk update, collection create, collection get, create, delete, doc delete, doc import-oss, doc list, doc status, doc tag, doc upload, file delete, file get, file list, info, list, retrieve, search, service copy, service create, service delete, service deploy, service get, service list, service update, stats, update |
knowledge.md |
mcp |
call, list, tools |
mcp.md |
memory |
add, delete, list, profile create, profile get, search, update |
memory.md |
model |
list |
model.md |
permission |
grant, list, revoke |
permission.md |
pipeline |
run, validate |
pipeline.md |
plugin |
install, link, list, remove |
plugin.md |
quota |
check, delete, history, list, update |
quota.md |
search |
web |
search.md |
skill |
add, init, list, remove, update |
skill.md |
text |
chat |
text.md |
token-plan |
add-member, assign-seats, create-key, list-seats |
token-plan.md |
update |
(root) |
update.md |
usage |
coding-plan, free, freetier, stats, summary, token-plan |
usage.md |
workspace |
init, list |
workspace.md |
Global flags
Available on every command (in addition to command-specific flags):
| Flag | Type | Required | Description |
|---|---|---|---|
--output <format> |
string | no | Output format: text, json |
--timeout <seconds> |
number | no | Request timeout |
--quiet |
switch | no | Suppress non-essential output |
--verbose |
switch | no | Print HTTP request/response details |
--dry-run |
switch | no | Dry run mode |
--config <name> |
string | no | Use a config profile for this command |
--help |
switch | no | Show help |
--version |
switch | no | Print version |
Model auth flags
Available on model-domain commands (API-key auth); also listed per command below:
| Flag | Type | Required | Description |
|---|---|---|---|
--api-key <key> |
string | no | API key |
--base-url <url> |
string | no | API base URL |
Console auth flags
Available on console-domain commands (console login auth); also listed per command below:
| Flag | Type | Required | Description |
|---|---|---|---|
--console-region <region> |
string | no | Console gateway region (e.g. cn-beijing, ap-southeast-1) |
--console-site <site> |
string | no | Console site: domestic, international |
--console-switch-agent <uid> |
number | no | Switch agent UID for delegated access |
--workspace-id <id> |
string | no | Workspace ID (env: BAILIAN_WORKSPACE_ID) |
OpenAPI auth flags
Available on OpenAPI-domain commands (AK/SK auth); also listed per command below:
| Flag | Type | Required | Description |
|---|---|---|---|
--access-key-id <key> |
string | no | Alibaba Cloud Access Key ID (env: ALIBABA_CLOUD_ACCESS_KEY_ID) |
--access-key-secret <key> |
string | no | Alibaba Cloud Access Key Secret (env: ALIBABA_CLOUD_ACCESS_KEY_SECRET) |
--security-token <token> |
string | no | Alibaba Cloud STS Security Token (env: ALIBABA_CLOUD_SECURITY_TOKEN) |
Notes
- Console commands (
app list,usage free,console call) requirebl auth login --console. - Most API commands use
DASHSCOPE_API_KEYorbl auth login --api-key. - Token Plan commands use OpenAPI AK/SK via
bl auth login --open-apiorALIBABA_CLOUD_ACCESS_KEY_ID/ALIBABA_CLOUD_ACCESS_KEY_SECRET. - Default output: text unless explicitly set to
jsonwith--output,DASHSCOPE_OUTPUT, or config.