Skip to content

Commit cc209ce

Browse files
Merge pull request #173 from modelstudioai/feat/update-install.md
Clarify install guide skill fallback and post-install tips
2 parents 4067b2c + 90d1ef9 commit cc209ce

1 file changed

Lines changed: 48 additions & 16 deletions

File tree

INSTALL.md

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,25 @@ npm install -g bailian-cli
1313
```
1414

1515
4. 校验:`bl --version`
16+
5. 按下方「安装 skills」安装。
1617

17-
安装 skills(CLI 内置,无需 Git / npx skills):
18+
### 安装 skills
19+
20+
**Supported(优先):** 用 CLI 内置命令一次装齐 registry 中全部 `bailian-*`(含共享协议 `bailian-protocol`):
1821

1922
```bash
2023
bl skill init
2124
```
2225

23-
**Supported:** `bl skill init` 一次装齐 registry 中全部 `bailian-*`(含共享协议 `bailian-protocol`)。
24-
25-
**Advanced / 按需子集:**
26+
**降级:**`bl skill init` 失败,先确认本机同时满足两个条件:`node -v` / `npm -v` 成功,**** `git --version` 成功。两个条件都成立时,再回退到:
2627

2728
```bash
28-
bl skill add --name bailian-protocol,bailian-gen
29+
npx skills@1.5.18 add modelstudioai/cli --all -g
2930
```
3031

31-
安装成功后,用中文简要说明已安装的 skills 及用户可做什么。
32+
> 必须使用 `skills@1.5.18`:这是最后兼容 Node ≥18 的版本(与 Bailian CLI 的 Node ≥18.17.0 一致);
33+
34+
安装成功后,按第 5 节向用户说明语言切换与能力 tip(若也装了 skills,一并简要说明)。
3235

3336
## 2. 备选:二进制安装(无需 Node)
3437

@@ -67,8 +70,6 @@ bl --version
6770
which bl # Windows: where.exe bl
6871
```
6972

70-
若自动 skill 安装失败,再手动执行:`bl skill init`
71-
7273
> CDN / GitHub Release 未就绪或下载失败时,若本机已有合格 Node,回退到上方 npm 安装。
7374
7475
---
@@ -99,12 +100,43 @@ which bl # Windows: where.exe bl
99100
bl auth status --output json
100101
```
101102

102-
## 5. 常见问题
103+
## 5. 安装成功后向用户说明(必做)
104+
105+
安装与校验完成后,**主动**用中文向用户说明下列两项;不要等用户追问。可执行 `bl`(已登录时)对照终端 tip,但以下列表为准,勿臆造。
106+
107+
### 5.1 界面语言
108+
109+
Bailian CLI 支持中英文界面(help / 欢迎语 / Quick Start 主次文案)。默认 `en-US`,可切换为 `zh-CN`
110+
111+
```bash
112+
bl config set --key language --value zh-CN
113+
bl config set --key language --value en-US
114+
```
103115

104-
| 现象 | 可能原因 | 建议动作 |
105-
| ------------------------ | ---------------------------- | ------------------------------------------------ |
106-
| `bl: command not found` | bin 不在 PATH | 检查 `~/.local/bin``npm prefix -g` |
107-
| curl 安装 404 | GitHub Release 资产未上传 | 改用 `npm install -g bailian-cli` |
108-
| Windows `bl update` 失败 | 旧布局 / 文件锁 / 网络 | 重跑 `irm .../install.ps1 \| iex` 迁移布局后重试 |
109-
| `plugin` 需要 npm | 二进制安装无本机 npm | 安装 Node,或改用 npm 版 CLI |
110-
| 安装报错 engines | Node 版本过低(仅 npm 路径) | 升级到 ≥ 18.17.0 |
116+
向用户说明:可随时用上述命令切换语言。
117+
118+
### 5.2 能力 tip(Quick Start)
119+
120+
向用户展示「试试使用Bailian CLI完成这些任务」及下列 5 条(中英各一行,与 `bl` 根帮助 tip 一致):
121+
122+
1. 帮我创建一个能够生成短片分镜和视频的 Managed Agent。
123+
Help me create a Managed Agent that can generate short-film storyboards and videos.
124+
2. 生成一张穿着太空服的猫站在火星上的图片,再把它制作成一段视频。
125+
Generate an image of a cat in a spacesuit standing on Mars, then turn it into a video.
126+
3. 查看最近的模型用量、免费额度和限流情况。
127+
Check my recent model usage, free quota, and rate limits.
128+
4. 推荐一个适合图片理解和智能客服的模型。
129+
Recommend a model suitable for image understanding and intelligent customer service.
130+
5. 介绍一下 Bailian CLI 能帮我完成哪些任务,并根据我的需求推荐使用方式。
131+
Explain what Bailian CLI can help me accomplish, and recommend how to use it based on my needs.
132+
133+
## 6. 常见问题
134+
135+
| 现象 | 可能原因 | 建议动作 |
136+
| ------------------------ | ---------------------------- | ---------------------------------------------------------------------------------------------- |
137+
| `bl: command not found` | bin 不在 PATH | 检查 `~/.local/bin``npm prefix -g` |
138+
| curl 安装 404 | GitHub Release 资产未上传 | 改用 `npm install -g bailian-cli` |
139+
| Windows `bl update` 失败 | 旧布局 / 文件锁 / 网络 | 重跑 `irm .../install.ps1 \| iex` 迁移布局后重试 |
140+
| `plugin` 需要 npm | 二进制安装无本机 npm | 安装 Node,或改用 npm 版 CLI |
141+
| 安装报错 engines | Node 版本过低(仅 npm 路径) | 升级到 ≥ 18.17.0 |
142+
| `bl skill init` 失败 | 网络 / registry 不可达等 | 有 Node 且有 Git 时降级 `npx skills@1.5.18 add modelstudioai/cli --all -g`;否则重试或告知用户 |

0 commit comments

Comments
 (0)