@volcengine/ark-cli 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +233 -44
  2. package/manifest.json +23 -23
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,93 +2,282 @@
2
2
 
3
3
  # Ark CLI
4
4
 
5
- **火山方舟(Volcengine Ark)官方命令行工具**
6
-
7
- 在终端里一句话**对话 · 生图 · 生视频 · 多模态理解 · 部署模型** —— 还能把这些能力一键装进你的 AI Agent。
5
+ **给你的 AI Agent 赋予火山方舟的全部能力**
8
6
 
9
7
  [![npm](https://img.shields.io/npm/v/@volcengine/ark-cli?color=brightgreen&label=npm)](https://www.npmjs.com/package/@volcengine/ark-cli)
10
8
  [![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
11
- [![node](https://img.shields.io/badge/node-%E2%89%A516-brightgreen)](https://nodejs.org)
9
+ [![node](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
10
+
11
+ 火山方舟模型、生成、多模态理解、Plan、精调、部署、用量、账单和诊断能力,都可以通过 Ark CLI + Skills 交给 Claude Code、OpenCode、Codex 等本地 Agent 调用。
12
12
 
13
13
  ```shell
14
- npm i -g @volcengine/ark-cli
14
+ npm i -g @volcengine/ark-cli@latest
15
15
  ```
16
16
 
17
17
  </div>
18
18
 
19
19
  ---
20
20
 
21
- ## 一分钟感受
21
+ ## Ark CLI 能做什么
22
+
23
+ 让你的 AI Agent 具备这些方舟能力,并能在复杂任务中组合调用:
24
+
25
+ - **模型调用**:文本对话、多模态输入、流式输出、多轮接续
26
+ - **图片 / 视频生成**:Seedream 生图、Seedance 生视频,产物自动下载到本地
27
+ - **多模态理解**:OCR、视频总结、语音转写、字幕打轴、文档字段抽取
28
+ - **Plan 管理**:Agent Plan / Coding Plan 查询、购买、续费、团队席位管理
29
+ - **Agent 接入**:安装 Ark Skills,配置 Harness / MCP,让本地 Agent 调用方舟能力
30
+ - **模型生产**:精调任务、自定义模型、训练状态跟踪
31
+ - **服务上线**:基础模型或自定义模型一键部署为 Endpoint
32
+ - **治理闭环**:Usage、Billing、Doctor、监控指标和错误码诊断
33
+
34
+ ## 为什么需要 Ark CLI
35
+
36
+ Ark CLI 不是让你记住更多命令,而是把火山方舟 MaaS 平台能力变成 Agent 可以调用的工具箱。
37
+
38
+ ```text
39
+ 消费链路:
40
+ 选择模型
41
+ -> 开通 Plan 或部署模型
42
+ -> 接入本地 Agent / Harness
43
+ -> 调用、理解、生成
44
+ -> 查看用量、账单、监控和诊断结果
45
+
46
+ 生产链路:
47
+ 准备数据
48
+ -> 创建精调任务
49
+ -> 得到自定义模型
50
+ -> 部署成 Endpoint
51
+ -> 回到消费链路继续使用
52
+ ```
53
+
54
+ ## 安装与初始化
22
55
 
23
56
  ```shell
24
- # 对话推理
25
- arkcli +chat "用一句话解释什么是 RAG"
57
+ # 1. 安装 CLI
58
+ npm i -g @volcengine/ark-cli@latest
59
+ arkcli --version
60
+
61
+ # 2. 登录火山方舟
62
+ arkcli auth login volc-sso
63
+ arkcli auth status
26
64
 
27
- # 文生图 —— 产物自动下载并打开
28
- arkcli +gen "赛博朋克风格的城市夜景,霓虹灯,雨夜"
65
+ # 3. 同步 Ark Skills 到本地 Agent
66
+ arkcli +connect
67
+ ```
68
+
69
+ 无浏览器环境,例如远程开发机、CI 或 Agent 沙箱:
29
70
 
30
- # 看看现在能用哪些模型
31
- arkcli models list
71
+ ```shell
72
+ arkcli auth login --no-browser
73
+ arkcli auth login --no-browser --code <授权码>
32
74
  ```
33
75
 
34
- 生视频、图生图、语音转写、文档抽取、视频总结、模型部署…… 都是一条命令的事。
76
+ ## 一次完整任务可以这样开始
35
77
 
36
- ## 为什么用它
78
+ 你可以直接告诉 Agent 一个目标:
37
79
 
38
- - 🚀 **一条命令,不写代码**:生图 / 对话 / 转写 / 部署,终端直接出结果,不用翻 SDK、不用搭环境。
39
- - 🎨 **图片 + 视频 + 多模态全覆盖**:Seedream 生图、Seedance 生视频,OCR / 视觉定位 / 视频总结 / 语音转写一站式。
40
- - 🤖 **装进你的 AI Agent**:一句 `arkcli +connect`,把上面所有能力作为 Skill 注入 Claude Code / OpenCode,让 Agent 用自然语言直接驱动火山方舟。
41
- - 🔌 **一套工具多种场景**:platform / agent-plan / coding-plan 多 profile,一致体验、随手切换。
80
+ ```text
81
+ 帮我选择一个适合图文理解的模型,配置到本地 Agent,
82
+ 然后用它总结一段视频,并告诉我本月用了多少 token。
83
+ ```
42
84
 
43
- ## 能做什么
85
+ Agent 可以通过 Ark CLI 串起完整流程:
44
86
 
45
- | 能力 | 命令 | 说明 |
46
- |------|------|------|
47
- | 💬 对话推理 | `arkcli +chat` | 多模态对话(文本 / 图片 / 视频 / 音频),流式输出、多轮接续 |
48
- | 🎨 生图生视频 | `arkcli +gen` | Seedream 文生图 / 图生图、Seedance 文生视频 / 图生视频,产物自动下载 |
49
- | 🔍 多模态理解 | `arkcli +understand` | OCR、视觉定位(框选)、文档抽取、视频总结、语音转写 / 翻译、字幕打轴 |
50
- | 🚀 部署模型 | `arkcli +deploy` · `arkcli infer endpoint` | 一键把模型部署成在线推理接入点(Endpoint) |
51
- | 📋 模型 / 用量 / 账单 | `arkcli models` · `arkcli usage` · `arkcli billing` | 查公共基础模型、推理用量、结算账单 |
52
- | 🤖 注入 AI Agent | `arkcli +connect` | 把上面这些能力作为 Skill 装进本机的 AI Agent |
87
+ ```text
88
+ arkcli models search
89
+ -> arkcli plans get / arkcli plans model-list
90
+ -> arkcli +connect / arkcli helper configure
91
+ -> arkcli +understand video-summary
92
+ -> arkcli usage stats / arkcli billing list
93
+ ```
53
94
 
54
- > 每个命令都自带 `--help`,例如 `arkcli +gen --help`。
95
+ 用户描述目标,Agent 负责选择命令、调用方舟能力、汇总结果。
55
96
 
56
- ## 快速开始
97
+ ## 常用任务
57
98
 
58
- **环境要求**:Node.js ≥ 16(自带 npm / npx)·支持 macOS / Linux / Windows(arm64 / amd64)
99
+ ### 选择并调用模型
59
100
 
60
101
  ```shell
61
- # 1. 安装
62
- npm config set registry https://registry.npmjs.org/
63
- npm i -g @volcengine/ark-cli@latest
64
- arkcli --version
102
+ arkcli +chat "总结一下 RAG 的核心思想"
103
+
104
+ arkcli +chat --input @photo.jpg "描述这张图片"
105
+
106
+ arkcli +understand video-summary --input @demo.mp4 "按章节总结这个视频"
107
+
108
+ arkcli +gen "生成一张未来城市海报"
109
+ ```
110
+
111
+ ### 开通和管理 Plan
112
+
113
+ ```shell
114
+ # 查看当前账号持有哪些套餐
115
+ arkcli plans get
116
+
117
+ # 查看 Plan 支持哪些模型
118
+ arkcli plans model-list --plan agent-plan
119
+
120
+ # 查看团队版席位
121
+ arkcli plans team seat-list --plan agent-plan-team
122
+
123
+ # 查看本机 Agent 上 Plan 相关能力状态
124
+ arkcli plans harness-status
125
+
126
+ # 购买或续费前先查看参数
127
+ arkcli plans buy --help
128
+ arkcli plans renew --help
129
+ ```
130
+
131
+ `plans buy` / `plans renew` 是计费操作,Ark CLI 会先展示协议和确认步骤,不会默认直接扣款。
132
+
133
+ ### 接入方舟服务能力
134
+
135
+ `+connect` 安装 Ark Skills,让 Agent 知道有哪些方舟任务可以做。`helper` 配置 Harness / MCP / Plan,让 Agent 真正接上模型和工具能力。
136
+
137
+ ```shell
138
+ # 查看会检测到哪些本地 Agent
139
+ arkcli +connect list
140
+
141
+ # 安装 Ark Skills
142
+ arkcli +connect
143
+
144
+ # 清理已注入的 Ark Skills
145
+ arkcli +connect uninstall
146
+
147
+ # 查看 Harness / Agent 配置状态
148
+ arkcli helper list
149
+
150
+ # 给当前 Agent 注入 MCP 工具能力
151
+ arkcli helper mcp
65
152
 
66
- # 2. 登录(火山引擎 SSO,运行后在浏览器完成授权)
153
+ # 配置指定 Harness,并同步注入 MCP
154
+ arkcli helper configure codex --with-mcp
155
+ ```
156
+
157
+ `arkcli +connect uninstall` 会清理注入到本地 Agent 的 `ark-` / `arkcli-` 前缀 Skills,适合想恢复干净 Agent 环境、或担心 Skills 过多影响 Agent 路由时使用。它不会卸载 `arkcli` 命令本身。
158
+
159
+ ### 生产模型
160
+
161
+ ```shell
162
+ arkcli train finetune --help
163
+ arkcli train finetune capability get --model <model> --version <version>
164
+ arkcli train finetune create --help
165
+ arkcli train finetune watch <job-id>
166
+ ```
167
+
168
+ ### 上线服务
169
+
170
+ ```shell
171
+ arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215 --dry-run
172
+ arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215
173
+ arkcli infer endpoint list
174
+ arkcli infer endpoint get <endpoint-id>
175
+ ```
176
+
177
+ ### 管成本、状态和健康
178
+
179
+ ```shell
180
+ arkcli usage plan
181
+ arkcli usage stats --start 2026-07-01 --mine
182
+ arkcli billing list --start 2026-07
183
+ arkcli billing list --start 2026-07 --endpoint ep-xxx
184
+
185
+ arkcli doctor
186
+ arkcli doctor model <model-name>
187
+ arkcli doctor infer-endpoint <endpoint-id>
188
+ arkcli doctor metrics request.qpm
189
+ arkcli doctor error ContentRiskBlocked
190
+ ```
191
+
192
+ `doctor` 默认是只读诊断,不会修改资源。需要修复时会通过确认流程执行。
193
+
194
+ ## 命令入口
195
+
196
+ | 任务 | 命令 |
197
+ |---|---|
198
+ | 对话和多模态推理 | `arkcli +chat` |
199
+ | 图片 / 视频生成 | `arkcli +gen` |
200
+ | OCR、视频总结、语音转写、文档抽取 | `arkcli +understand` |
201
+ | 模型查询 | `arkcli models` |
202
+ | Plan / 套餐管理 | `arkcli plans` |
203
+ | Agent 接入和 Harness 配置 | `arkcli +connect`, `arkcli helper` |
204
+ | 精调任务 | `arkcli train finetune` |
205
+ | 一键部署 Endpoint | `arkcli +deploy` |
206
+ | Endpoint 管理 | `arkcli infer endpoint` |
207
+ | 用量查询 | `arkcli usage` |
208
+ | 账单查询 | `arkcli billing` |
209
+ | 诊断和自助排障 | `arkcli doctor` |
210
+
211
+ 每个命令都自带帮助:
212
+
213
+ ```shell
214
+ arkcli +chat --help
215
+ arkcli +gen --help
216
+ arkcli +understand --help
217
+ arkcli +deploy --help
218
+ arkcli plans --help
219
+ arkcli doctor --help
220
+ ```
221
+
222
+ ## 认证
223
+
224
+ 推荐使用火山 SSO:
225
+
226
+ ```shell
67
227
  arkcli auth login volc-sso
228
+ ```
229
+
230
+ 登录后 Ark CLI 会自动完成身份、profile 和 API Key 配置。你通常不需要手动复制密钥。
231
+
232
+ ```shell
68
233
  arkcli auth status
234
+ arkcli auth apikey
235
+ arkcli auth logout
236
+ ```
69
237
 
70
- # 3. 上手
71
- arkcli +chat "你好,介绍下你自己"
238
+ ## 配置
239
+
240
+ ```shell
241
+ # 查看当前 profile
242
+ arkcli profile show
243
+
244
+ # 列出所有 profile
245
+ arkcli profile list
246
+
247
+ # 切换 profile
248
+ arkcli profile use <profile-name>
72
249
  ```
73
250
 
74
- > **无浏览器环境**(CI / 远程开发机 / Agent 沙箱):`arkcli auth login --no-browser`,在任意设备完成授权后用 `--code <码>` 粘回。
251
+ 更多 profile 管理能力可查看 `arkcli profile --help`。
252
+
253
+ ## AI Agent Skills
75
254
 
76
- ## 把能力装进你的 AI Agent
255
+ 本仓库的 [`skills/`](https://github.com/volcengine/ark-cli/tree/main/skills) 收录了 Ark CLI 内置的 Agent Skills。执行:
77
256
 
78
257
  ```shell
79
258
  arkcli +connect
80
259
  ```
81
260
 
82
- `+connect` 会自动检测本机的 AI Agent(Claude Code / OpenCode 等)并安装 Ark Skills。装好后,你在 Agent 里用**自然语言**就能驱动上面所有能力——“帮我生成一张图”“把这段录音转写成文字”“把某个模型部署成 Endpoint”。
261
+ Ark CLI 会把这些 Skills 安装到本机 Agent,使 Agent 能通过自然语言调用火山方舟能力,包括对话、多模态理解、图片视频生成、模型查询、Plan 管理、Endpoint 部署、精调、用量、账单和诊断。
83
262
 
84
- ## 浏览内置 Skills
263
+ ## 用户交流群
85
264
 
86
- 本仓库的 [`skills/`](https://github.com/volcengine/ark-cli/tree/main/skills) 收录了 arkcli 全部内置 AI Agent Skills(对话 / 生成 / 理解 / 部署 / 模型 / 用量 / 账单 / 套餐 …),每个都是一份可读的 `SKILL.md`。`arkcli +connect` 装进你 Agent 的就是它们。
265
+ 扫码加入 Ark CLI 飞书用户交流群,获取使用答疑、问题排查、Bug 反馈和使用经验交流支持。你可以在群里咨询安装、登录、模型调用、Skill 使用、版本升级等问题,也欢迎反馈 GitHub Issues 中未覆盖的异常。
266
+
267
+ 请勿在群内发送 API Key、AK/SK、Token 等敏感信息。对于可稳定复现的 Bug,建议同步提交 GitHub Issue,便于跟踪和修复。
268
+
269
+ <img src="./assets/lark-user-group.png" width="360" alt="Ark CLI 飞书用户交流群二维码" />
87
270
 
88
271
  ## 链接
89
272
 
90
- - 🌋 火山方舟控制台 & 文档:<https://www.volcengine.com/product/ark>
91
- - 📦 npm:<https://www.npmjs.com/package/@volcengine/ark-cli>
273
+ - 火山方舟:<https://www.volcengine.com/product/ark>
274
+ - npm:<https://www.npmjs.com/package/@volcengine/ark-cli>
275
+ - GitHub Releases:<https://github.com/volcengine/ark-cli/releases>
276
+ - 内置 Skills:<https://github.com/volcengine/ark-cli/tree/main/skills>
277
+
278
+ ## Changelog
279
+
280
+ Release notes live in [GitHub Releases](https://github.com/volcengine/ark-cli/releases).
92
281
 
93
282
  ## License
94
283
 
package/manifest.json CHANGED
@@ -1,64 +1,64 @@
1
1
  {
2
- "version": "1.0.2",
2
+ "version": "1.0.4",
3
3
  "platforms": {
4
4
  "darwin-amd64": {
5
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-darwin-amd64",
6
- "sha256": "ba7e088f5c2617b52de00c3b3017ee460ce56288ff654a4badbe7561d800136e",
5
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-darwin-amd64",
6
+ "sha256": "d80b7ebe32dc565192a65710062321565bad002b359c45005dee99c6dcb49d2c",
7
7
  "fallback": {
8
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-darwin-amd64",
8
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-darwin-amd64",
9
9
  "kind": "github-release"
10
10
  }
11
11
  },
12
12
  "darwin-arm64": {
13
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-darwin-arm64",
14
- "sha256": "32e4b560dc7a3ba9f5247e18e7359d1a050fbd4412cf75afcef9d98ed619c990",
13
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-darwin-arm64",
14
+ "sha256": "83815676b79e0757ffe37f4191a027741937d786ca4ad396497bdabb04b75a2e",
15
15
  "fallback": {
16
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-darwin-arm64",
16
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-darwin-arm64",
17
17
  "kind": "github-release"
18
18
  }
19
19
  },
20
20
  "linux-amd64": {
21
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-linux-amd64",
22
- "sha256": "2eb1630e5d90f3a572a8bf190a5dbe212435789d9456fcdb2cee029dc50ef476",
21
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-linux-amd64",
22
+ "sha256": "15b86e2ad5d677c2cc8f9e7fc973154f6b8890d0256b9d225f9d3e9d3af66541",
23
23
  "fallback": {
24
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-linux-amd64",
24
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-linux-amd64",
25
25
  "kind": "github-release"
26
26
  }
27
27
  },
28
28
  "linux-arm64": {
29
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-linux-arm64",
30
- "sha256": "b79b92878ba0ebe81b48f15a7b3f6be69cf22de4c84799ef921f075f11be2eae",
29
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-linux-arm64",
30
+ "sha256": "0305e3a03b1bb880bb14def6c66a54c2b525375cc23543947edd70f270da819d",
31
31
  "fallback": {
32
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-linux-arm64",
32
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-linux-arm64",
33
33
  "kind": "github-release"
34
34
  }
35
35
  },
36
36
  "windows-amd64": {
37
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-windows-amd64.exe",
38
- "sha256": "c41b597ec6aedca8bfcc5ddc7e2862d26142e5bb83eed63715a23371666602c0",
37
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-windows-amd64.exe",
38
+ "sha256": "a595a5f4cd68879428467c2fffa96b68ed90bcc39196e3e4a13136f76947de69",
39
39
  "fallback": {
40
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-windows-amd64.exe",
40
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-windows-amd64.exe",
41
41
  "kind": "github-release"
42
42
  }
43
43
  },
44
44
  "windows-arm64": {
45
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-windows-arm64.exe",
46
- "sha256": "e8e15cda610bf0ac6697e9226f629af537a0540f66d528834496900e6b61bc6c",
45
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/arkcli-1.0.4-windows-arm64.exe",
46
+ "sha256": "ece3ebb827ed07ef00ed38aa6a04621fff9b6f4b736a6fe64f4f4ac108b0409d",
47
47
  "fallback": {
48
- "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-windows-arm64.exe",
48
+ "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.4/arkcli-1.0.4-windows-arm64.exe",
49
49
  "kind": "github-release"
50
50
  }
51
51
  }
52
52
  },
53
53
  "skills": {
54
54
  "primary": {
55
- "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/skills.tar.gz",
56
- "sha256": "08ef3ddf5a8168b93d8623748a6c887b83f514448e10789fa3b6ee95fc509fa0",
55
+ "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.4/skills.tar.gz",
56
+ "sha256": "5a41b1187a09f8c4d9d14b7d8865ccdfc321aeeefaeec16f3b4805be21f393e0",
57
57
  "kind": "cdn"
58
58
  },
59
- "tag": "v1.0.2",
59
+ "tag": "v1.0.4",
60
60
  "fallback": {
61
- "url": "https://github.com/volcengine/ark-cli/archive/refs/tags/v1.0.2.tar.gz",
61
+ "url": "https://github.com/volcengine/ark-cli/archive/refs/tags/v1.0.4.tar.gz",
62
62
  "kind": "github"
63
63
  }
64
64
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volcengine/ark-cli",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "description": "火山方舟 ARK 平台命令行工具",
5
5
  "bin": {
6
6
  "arkcli": "scripts/run.js"