Skip to content

Commit 978f332

Browse files
Merge pull request #142 from modelstudioai/docs/update-readme-and-agent-guides
docs: refresh READMEs and auth maintenance guidance
2 parents 6338df3 + 0383976 commit 978f332

5 files changed

Lines changed: 294 additions & 545 deletions

File tree

README.md

Lines changed: 71 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,26 @@
1313

1414
---
1515

16-
_Chat with Qwen, generate images & videos, understand images, call agents,_
17-
_manage memory, search the web — all from your terminal._
16+
_Chat with Qwen, generate and edit images and videos, understand images, synthesize_
17+
_and recognize speech, call apps, manage memory, retrieve knowledge, search the web —_
18+
_every AI capability, one command away._
1819

1920
_Built for AI Agents. Every command works as a structured tool call._
2021

2122
</div>
2223

2324
## Features
2425

25-
Equip your AI Agent out-of-the-box with these capabilities, composable across complex tasks:
26+
- **Model generation** — Full-modality generation across text, image, video, and speech, with editing and reference-based generation
27+
- **Asset understanding** — Parse and ask questions about images, documents, audio, and long videos
28+
- **App orchestration** — Call Managed Agents, agents, and workflows published on Aliyun Model Studio, wired to knowledge bases, memory, web search, and MCP tools
29+
- **Training & deployment** — Validate and upload datasets, fine-tune models, deploy dedicated models as endpoints
30+
- **Account operations** — Login, UI-based configuration, model marketplace, usage and quota, rate-limit increases, team seat management
31+
- **Plan onboarding** — Connect subscription plans such as Token Plan to the CLI and common coding agents in one step
2632

27-
- **Text chat** — Qwen3.8-max: major gains in agentic coding, frontend coding, and vibe coding
28-
- **Multimodal (Omni)** — Full omni-modal support across text + image + audio + video
29-
- **Image generation & editing** — Qwen-Image 3.0: pro text rendering, photorealism, strong semantic adherence, multi-image composition
30-
- **Video generation & editing** — happyhorse-1.1 series: text-/image-/reference-to-video and natural-language video editing (up to 9-image reference)
31-
- **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
32-
- **Image & video understanding** — Qwen-VL: long-form video analysis, chart/document parsing, visual reasoning, multilingual OCR
33-
- **Coding agent setup** — Configure Claude Code, Qwen Code, OpenCode, OpenClaw, Hermes Agent, or Codex to use DashScope with `bl config agent`
33+
> **Note:** App orchestration, training & deployment, account operations, and plan onboarding are currently available only to China site (aliyun.com) account holders and are not yet supported for international / global site accounts.
3434
35-
> **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.
36-
37-
- **Knowledge base & memory** — Multimodal RAG retrieval and cross-session memory for personalized, coherent dialogue
38-
- **App calls** — Invoke agents and workflows already published on Aliyun Model Studio
39-
- **MCP integration** — Orchestrate Bailian MCP servers: list services, inspect tools, and invoke any tool directly from the terminal
40-
- **Web search** — Real-time internet retrieval for up-to-date, accurate answers
41-
- **Model recommendation** — Describe your scenario and get best-fit model suggestions; supports scoped search, model comparison, and alternative discovery
42-
- **Fine-tuning & deployment** — Upload datasets, create text/audio/image fine-tune jobs (`finetune text|audio|image create`; text covers SFT/LoRA/DPO/CPT), probe job status non-blockingly (`finetune watch`), query per-model training capability (`finetune capability`), and deploy trained models as endpoints (`deploy text|audio|image create`)
43-
- **Console capabilities** — Browse the model marketplace (`model list`) and Bailian apps (`app list`), review a unified usage view (`usage summary`), check free-tier quota (`usage free`), view model usage statistics (`usage stats`), manage workspaces (`workspace list`), and manage rate limits (`quota list/request/check/history`)
44-
- **Local file auto-upload** — Every URL parameter accepts a local path; uploaded to free temp storage with 48-hour validity
45-
46-
## Showcase: One-Sentence Cinematic Video
35+
## Showcase 1: A Cinematic Short Film from One Sentence
4736

4837
<p align="center">
4938
<a href="https://cloud.video.taobao.com/vod/dS2F4huqbw5Nfe5L3wwb3grz2q2DNYD3retq8dU-iHo.mp4">
@@ -56,156 +45,98 @@ Equip your AI Agent out-of-the-box with these capabilities, composable across co
5645
A complete **2-minute, 16:9 cinematic short film** — produced end-to-end from a single natural-language sentence, with **zero manual editing**. This showcase demonstrates how an AI Agent can compose a multi-step creative pipeline by orchestrating three primitives:
5746

5847
- **[Qwen Code](https://github.com/QwenLM/qwen-code)** — the agentic coding model that interprets the user's intent and drives the workflow
59-
- **[Aliyun Model Studio CLI](https://bailian.console.aliyun.com/cli?source_channel=cli_github&)** — invokes **HappyHorse 1.1**, Aliyun Model Studio's text-/image-/reference-to-video generation model
48+
- **[Aliyun Model Studio CLI](https://github.com/modelstudioai/cli/)** — invokes **HappyHorse 1.1**, Aliyun Model Studio's text-/image-/reference-to-video generation model
6049
- **[spark-video Skill](https://github.com/JohnKeating1997/spark-video)** — handles scene decomposition, storyboarding, shot continuity, and final stitching
6150

6251
### The single prompt
6352

6453
> _"Generate a roughly 2-minute video in Japanese cinematic style — a sweet, innocent first-love story about a high-school girl. The plot should be heart-fluttering enough to make viewers want to fall in love. Aspect ratio: 16:9."_
65-
>
66-
> _(Original: "帮我生成一段日系影视风格,高中女生的青涩初恋故事,剧情高甜,让人看了想谈恋爱,2分钟左右的视频,尺寸是16:9")_
67-
68-
### How it works
69-
70-
1. **Qwen Code** parses the request, plans the narrative beats, and decides which tools to call.
71-
2. The **spark-video Skill** breaks the story into shots, writes per-shot prompts, and enforces visual continuity (characters, lighting, palette, lens language).
72-
3. **`bl video generate`** dispatches each shot to **HappyHorse 1.1** in parallel.
73-
4. The skill stitches all clips back together into a single 16:9 / ~2-min deliverable.
74-
75-
No timeline scrubbing. No frame-by-frame editing. Just one sentence → one video.
76-
77-
## Installation
7854
79-
```bash
80-
# Recommended — no Node required
81-
curl -fsSL https://bailian.aliyun.com/cli/install.sh | bash
55+
## Showcase 2: A Short-Film Director Managed Agent from One Sentence
8256

83-
# Windows (PowerShell)
84-
irm https://bailian.aliyun.com/cli/install.ps1 | iex
57+
<p align="center">
58+
<a href="https://cloud.video.taobao.com/vod/2v0GYLbJSQb2saj4iopTJDW3iRIHsintYlK-wTKbhqE.mp4">
59+
<img src="https://img.alicdn.com/imgextra/i4/6000000001674/O1CN01xhzixhxltbH3LxWu_!!6000000001674-0-tbvideo.jpg" alt="Click to play the demo video" width="720" />
60+
</a>
61+
</p>
8562

86-
# Node users / developers (Node.js >= 18.17)
87-
npm install -g bailian-cli
63+
<p align="center"><i>👆 Click the cover to play the full demo</i></p>
8864

89-
# Agent skills
90-
npx skills add modelstudioai/cli --all -g
91-
```
65+
One sentence builds a reusable cloud-side short-film director for storyboarding, storyboard image generation, and video creation:
9266

93-
> Binary install does not require Node.js. `npm install -g` remains fully supported.
67+
- **[Qwen Code](https://github.com/QwenLM/qwen-code)** — understands the requirement and generates the agent configuration
68+
- **[Aliyun Model Studio CLI](https://github.com/modelstudioai/cli/)** — validates the configuration, previews the changes, and completes the deployment
69+
- **[Managed Agent](https://bailian.console.aliyun.com/cn-beijing/?tab=managed-agents#/managed-agents/quick-start)** — runs the director role along with its skills and tools in the cloud
9470

95-
## Quick Start
96-
97-
```bash
98-
# Authenticate, recommended
99-
bl auth login --console
71+
### The single prompt
10072

101-
# Or authenticate with an API key
102-
bl auth login --api-key sk-xxxxx
73+
> _"Build me a Managed Agent app that can produce short films — a director expert that generates videos and can also design the matching storyboards."_
10374
104-
# Or use Token Plan (Base URL built in; the key is tested during login)
105-
bl auth login --config token-plan --api-key sk-sp-xxxxx
75+
## Installation
10676

107-
# Configure a coding agent to use DashScope
108-
bl config agent --agent codex --base-url https://dashscope.aliyuncs.com/compatible-mode/v1 --api-key sk-xxxxx --model qwen3-coder-plus
77+
**Agent install (recommended)**
10978

110-
# Chat with Qwen
111-
bl text chat --message "What is DashScope?"
79+
Send the following to your Agent — it will detect your environment, then install and verify the CLI for you:
11280

113-
# Multimodal chat (text + image + audio + video)
114-
bl omni --message "Describe this image" --image ./photo.jpg
81+
```text
82+
Please read https://bailian.aliyun.com/cli/install.md and install the Aliyun Model Studio CLI for me
83+
```
11584

116-
# Generate an image
117-
bl image generate --prompt "A cat in a spacesuit" --out-dir ./images/
85+
**Manual install (npm)**
11886

119-
# Generate a video from local image
120-
bl video generate --image ./cat.png --prompt "Make the cat move" --download cat.mp4
87+
```bash
88+
npm install -g bailian-cli
89+
npx skills add modelstudioai/cli --all -g
90+
```
12191

122-
# Model recommendation — find the best model for your use case
123-
bl advisor recommend --message "I need a visual-understanding chatbot"
92+
> Requires Node.js >= 18.17.
12493
125-
# Compare specific models
126-
bl advisor recommend --message "qwen-max vs deepseek-v3 for code generation"
94+
## Quick Start
12795

128-
# Browser login (required for console capability commands)
129-
bl auth login --console
96+
Once installed, just describe your task to your AI Agent — no need to assemble commands by hand.
13097

131-
# Fine-tune & deploy — a one-shot train-to-serve workflow
132-
bl dataset upload --file ./train.jsonl # Upload a .jsonl dataset (validated first)
133-
bl finetune text create --model qwen3-8b --datasets ./train.jsonl --training-type sft-lora # Local paths auto-upload
134-
bl finetune watch --job-id ft-xxx --output json # Non-blocking probe (running/succeeded return 0; failed/canceled report an error)
135-
bl finetune capability --model qwen3-8b # Which training types a model supports
136-
bl deploy text create --model qwen3-8b --name my-svc --plan mu # Deploy the trained model as an endpoint
137-
138-
# Browse models / apps / free-tier quota / usage statistics / workspaces
139-
bl model list # Browse model families and pricing
140-
bl app list
141-
bl usage summary # Unified view: free-tier quota + recent usage overview
142-
bl usage free # Free-tier quota across models (add --model/--expiring/--sort)
143-
bl usage stats --workspace-id <id> # Model usage statistics (add --model for per-model)
144-
bl workspace list # List all workspaces
145-
146-
# Rate limit management (list / check / request / history)
147-
bl quota list # View RPM/TPM limits (add --model to filter)
148-
bl quota check # Current usage vs rate limits (add --model/--period)
149-
bl quota request --model qwen3.6-plus --tpm 6000000 # Request a temporary TPM increase
150-
bl quota history # View quota-change history
151-
152-
# Token Plan team management (requires AK/SK, see auth below)
153-
bl token-plan list-seats # View subscription seat details
154-
bl token-plan add-member --account-name dev --org-id org_xxx
155-
bl token-plan assign-seats --workspace-id ws_xxx --seat-type standard --account-id acc_xxx
156-
bl token-plan create-key --account-id acc_xxx --workspace-id ws_xxx
157-
```
98+
| Scenario | What to say to your Agent |
99+
| ------------------------ | --------------------------------------------------------------------------------- |
100+
| Managed Agent | "Create a Managed Agent that can generate short-film storyboards and videos." |
101+
| Image & video generation | "Generate an image of a cat in a spacesuit on Mars, then turn it into a video." |
102+
| Usage & quota | "Show my recent model usage, free-tier quota, and rate limits." |
103+
| Model selection | "Recommend a model for image understanding and customer support." |
104+
| About Bailian CLI | "Tell me what Bailian CLI can do for me, and suggest how to use it for my needs." |
158105

159106
> More examples and scenarios: [Aliyun Model Studio CLI Site](https://bailian.console.aliyun.com/cli?source_channel=cli_github&)
160107
161108
## Authentication
162109

163-
### DashScope API Key
110+
### API Key
164111

165112
Required for most commands. Get your key from the [DashScope Console](https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key).
166113

167114
```bash
168-
# Option 1: Environment variable
169-
export DASHSCOPE_API_KEY=sk-xxxxx
170-
171-
# Option 2: Login command (persisted to ~/.bailian/config.json)
172115
bl auth login --api-key sk-xxxxx
173-
174-
# Option 3: Per-command flag
175-
bl text chat --api-key sk-xxxxx --message "Hello"
176116
```
177117

178-
### Token Plan API Key
179-
180-
Get or copy the API key from the [Token Plan subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview).
181-
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.
118+
Get or copy your Token Plan API key from the [Token Plan subscription overview](https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview).
182119

183120
```bash
184121
bl auth login --config token-plan --api-key sk-sp-xxxxx
185122
```
186123

187124
### Console Login (OAuth)
188125

189-
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.
126+
Required for console capability commands (model list, app list, MCP list, workspace, usage queries, rate-limit increases, direct console calls). Opens the Bailian console in your browser to sign in.
190127

191128
```bash
192129
bl auth login --console
193130
```
194131

195-
### Alibaba Cloud OpenAPI AK/SK (Token Plan only)
132+
### Alibaba Cloud OpenAPI AK/SK
196133

197-
Required for the `token-plan` command group. Get your AccessKey from [RAM Console](https://ram.console.aliyun.com/manage/ak).
134+
Token Plan seat and member management requires an Alibaba Cloud AccessKey. Get yours from the [RAM Console](https://ram.console.aliyun.com/manage/ak).
198135

199136
> Recommended: create a RAM sub-account with minimum privileges instead of using the root account's AK/SK.
200137
201138
```bash
202-
# Option 1: Login command (persisted to ~/.bailian/config.json)
203139
bl auth login --open-api --access-key-id LTAI5t... --access-key-secret ...
204-
205-
# Option 2: Environment variables
206-
export ALIBABA_CLOUD_ACCESS_KEY_ID=LTAI5t...
207-
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=...
208-
export BAILIAN_WORKSPACE_ID=ws-...
209140
```
210141

211142
## Configuration
@@ -214,18 +145,31 @@ export BAILIAN_WORKSPACE_ID=ws-...
214145
# View current config
215146
bl config show
216147

217-
# Set defaults
218-
bl config set --key base_url --value https://dashscope-us.aliyuncs.com
219-
bl config set --key default_text_model --value qwen-turbo
220-
bl config set --key timeout --value 600
148+
# List all config profiles
149+
bl config list
221150

222-
# Self-update to latest or a specific version
223-
bl update
224-
bl update --to 0.1.14
151+
# Switch config profile
152+
bl config use --name token-plan
225153
```
226154

227155
Config file location: `~/.bailian/config.json`
228156

157+
## Update
158+
159+
```bash
160+
bl update
161+
```
162+
163+
Upgrades the CLI to the latest version and refreshes the installed Agent Skills. Release notes for every version live in [CHANGELOG.md](https://github.com/modelstudioai/cli/blob/main/CHANGELOG.md).
164+
165+
## Contributing
166+
167+
Bug reports, feature requests, and PRs are welcome. See [CONTRIBUTING.md](https://github.com/modelstudioai/cli/blob/main/CONTRIBUTING.md) for developer setup, repo layout, and the workflow for adding or changing commands.
168+
169+
Scan the QR code to join the Aliyun Model Studio CLI DingTalk user group for usage help, troubleshooting, bug reports, and tips from other users.
170+
171+
<img src="https://img.alicdn.com/imgextra/i3/O1CN015uuhYGb6j0L12xJZ_!!6000000006304-2-tps-516-485.png" alt="Aliyun Model Studio CLI DingTalk user group" width="240" />
172+
229173
## Links
230174

231175
| Resource | URL |
@@ -237,11 +181,3 @@ Config file location: `~/.bailian/config.json`
237181
| Get API Key | https://bailian.console.aliyun.com/cn-beijing/?source_channel=key_github&tab=app#/api-key |
238182
| Get Token Plan API Key | https://bailian.console.aliyun.com/cn-beijing?tab=plan#/efm/subscription/overview |
239183
| Get AccessKey | https://ram.console.aliyun.com/manage/ak |
240-
241-
## Changelog
242-
243-
Release notes for every version live in [CHANGELOG.md](https://github.com/modelstudioai/cli/blob/main/CHANGELOG.md).
244-
245-
## Contributing
246-
247-
Bug reports, feature requests, and PRs are welcome. See [CONTRIBUTING.md](https://github.com/modelstudioai/cli/blob/main/CONTRIBUTING.md) for developer setup, repo layout, and the workflow for adding or changing commands.

0 commit comments

Comments
 (0)