@volcengine/ark-cli - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

manifest.json

 {
-  "version": "1.0.2",
+  "version": "1.0.3",
   "platforms": {
     "darwin-amd64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-darwin-amd64",
-      "sha256": "ba7e088f5c2617b52de00c3b3017ee460ce56288ff654a4badbe7561d800136e",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-darwin-amd64",
+      "sha256": "3f3201a6e906223f8be6b6f304a28a28dd8c8c333f4ac89f24f6052110eee093",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-darwin-amd64",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-darwin-amd64",
         "kind": "github-release"
@@ -13,6 +13,6 @@ }
     "darwin-arm64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-darwin-arm64",
-      "sha256": "32e4b560dc7a3ba9f5247e18e7359d1a050fbd4412cf75afcef9d98ed619c990",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-darwin-arm64",
+      "sha256": "ea0a8d8139f6329bb22a4ffd6095d451fac2b5e8a422a0e0c957e2bc7f06b734",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-darwin-arm64",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-darwin-arm64",
         "kind": "github-release"
@@ -22,6 +22,6 @@ }
     "linux-amd64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-linux-amd64",
-      "sha256": "2eb1630e5d90f3a572a8bf190a5dbe212435789d9456fcdb2cee029dc50ef476",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-linux-amd64",
+      "sha256": "74ec6b7e014cf1c084574a05efaad8d857fb11f6661c6740d79688139cc7c4b7",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-linux-amd64",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-linux-amd64",
         "kind": "github-release"
@@ -31,6 +31,6 @@ }
     "linux-arm64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-linux-arm64",
-      "sha256": "b79b92878ba0ebe81b48f15a7b3f6be69cf22de4c84799ef921f075f11be2eae",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-linux-arm64",
+      "sha256": "c0120aceca4a9069f274f5f5a4b3f272c71fb2dab3db2b666267fc8067754a5b",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-linux-arm64",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-linux-arm64",
         "kind": "github-release"
@@ -40,6 +40,6 @@ }
     "windows-amd64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-windows-amd64.exe",
-      "sha256": "c41b597ec6aedca8bfcc5ddc7e2862d26142e5bb83eed63715a23371666602c0",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-windows-amd64.exe",
+      "sha256": "9c95940be1f0ce6233152abbd24966390a8f55931ddd40e3b50d22bf44d326db",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-windows-amd64.exe",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-windows-amd64.exe",
         "kind": "github-release"
@@ -49,6 +49,6 @@ }
     "windows-arm64": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/arkcli-1.0.2-windows-arm64.exe",
-      "sha256": "e8e15cda610bf0ac6697e9226f629af537a0540f66d528834496900e6b61bc6c",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/arkcli-1.0.3-windows-arm64.exe",
+      "sha256": "8c4b338c0ceb8dc455b98058a0815bb97db52a1a90b551fb0a4dfe3d56136fd3",
       "fallback": {
-        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.2/arkcli-1.0.2-windows-arm64.exe",
+        "url": "https://github.com/volcengine/ark-cli/releases/download/v1.0.3/arkcli-1.0.3-windows-arm64.exe",
         "kind": "github-release"
@@ -60,9 +60,9 @@ }
     "primary": {
-      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.2/skills.tar.gz",
-      "sha256": "08ef3ddf5a8168b93d8623748a6c887b83f514448e10789fa3b6ee95fc509fa0",
+      "url": "https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/prod/1.0.3/skills.tar.gz",
+      "sha256": "a4f4146635a52068c0b0db8fb024d6f679ef76c2724d3ce279a75f6436527038",
       "kind": "cdn"
     },
-    "tag": "v1.0.2",
+    "tag": "v1.0.3",
     "fallback": {
-      "url": "https://github.com/volcengine/ark-cli/archive/refs/tags/v1.0.2.tar.gz",
+      "url": "https://github.com/volcengine/ark-cli/archive/refs/tags/v1.0.3.tar.gz",
       "kind": "github"
@@ -69,0 +69,0 @@ }

package.json

 {
   "name": "@volcengine/ark-cli",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "火山方舟 ARK 平台命令行工具",
@@ -5,0 +5,0 @@ "bin": {

README.md

@@ -5,12 +5,12 @@ <div align="center">
 
-**火山方舟（Volcengine Ark）官方命令行工具**
+**给你的 AI Agent 赋予火山方舟的全部能力**
 
-在终端里一句话**对话 · 生图 · 生视频 · 多模态理解 · 部署模型** —— 还能把这些能力一键装进你的 AI Agent。
-
 [![npm](https://img.shields.io/npm/v/@volcengine/ark-cli?color=brightgreen&label=npm)](https://www.npmjs.com/package/@volcengine/ark-cli)
 [![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
-[![node](https://img.shields.io/badge/node-%E2%89%A516-brightgreen)](https://nodejs.org)
+[![node](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
 
+火山方舟模型、生成、多模态理解、Plan、精调、部署、用量、账单和诊断能力，都可以通过 Ark CLI + Skills 交给 Claude Code、OpenCode、Codex 等本地 Agent 调用。
+
 ```shell
-npm i -g @volcengine/ark-cli
+npm i -g @volcengine/ark-cli@latest
 ```
@@ -22,59 +22,238 @@
 
-## ✨ 一分钟感受
+## Ark CLI 能做什么
 
+让你的 AI Agent 具备这些方舟能力，并能在复杂任务中组合调用：
+
+- **模型调用**：文本对话、多模态输入、流式输出、多轮接续
+- **图片 / 视频生成**：Seedream 生图、Seedance 生视频，产物自动下载到本地
+- **多模态理解**：OCR、视频总结、语音转写、字幕打轴、文档字段抽取
+- **Plan 管理**：Agent Plan / Coding Plan 查询、购买、续费、团队席位管理
+- **Agent 接入**：安装 Ark Skills，配置 Harness / MCP，让本地 Agent 调用方舟能力
+- **模型生产**：精调任务、自定义模型、训练状态跟踪
+- **服务上线**：基础模型或自定义模型一键部署为 Endpoint
+- **治理闭环**：Usage、Billing、Doctor、监控指标和错误码诊断
+
+## 为什么需要 Ark CLI
+
+Ark CLI 不是让你记住更多命令，而是把火山方舟 MaaS 平台能力变成 Agent 可以调用的工具箱。
+
+```text
+消费链路:
+选择模型
+  -> 开通 Plan 或部署模型
+  -> 接入本地 Agent / Harness
+  -> 调用、理解、生成
+  -> 查看用量、账单、监控和诊断结果
+
+生产链路:
+准备数据
+  -> 创建精调任务
+  -> 得到自定义模型
+  -> 部署成 Endpoint
+  -> 回到消费链路继续使用
+```
+
+## 安装与初始化
+
 ```shell
-# 对话推理
-arkcli +chat "用一句话解释什么是 RAG"
+# 1. 安装 CLI
+npm i -g @volcengine/ark-cli@latest
+arkcli --version
 
-# 文生图 —— 产物自动下载并打开
-arkcli +gen "赛博朋克风格的城市夜景，霓虹灯，雨夜"
+# 2. 登录火山方舟
+arkcli auth login volc-sso
+arkcli auth status
 
-# 看看现在能用哪些模型
-arkcli models list
+# 3. 同步 Ark Skills 到本地 Agent
+arkcli +connect
 ```
 
-生视频、图生图、语音转写、文档抽取、视频总结、模型部署…… 都是一条命令的事。
+无浏览器环境，例如远程开发机、CI 或 Agent 沙箱：
 
-## 为什么用它
+```shell
+arkcli auth login --no-browser
+arkcli auth login --no-browser --code <授权码>
+```
 
-- 🚀 **一条命令，不写代码**：生图 / 对话 / 转写 / 部署，终端直接出结果，不用翻 SDK、不用搭环境。
-- 🎨 **图片 + 视频 + 多模态全覆盖**：Seedream 生图、Seedance 生视频，OCR / 视觉定位 / 视频总结 / 语音转写一站式。
-- 🤖 **装进你的 AI Agent**：一句 `arkcli +connect`，把上面所有能力作为 Skill 注入 Claude Code / OpenCode，让 Agent 用自然语言直接驱动火山方舟。
-- 🔌 **一套工具多种场景**：platform / agent-plan / coding-plan 多 profile，一致体验、随手切换。
+## 一次完整任务可以这样开始
 
-## 能做什么
+你可以直接告诉 Agent 一个目标：
 
-| 能力 | 命令 | 说明 |
-|------|------|------|
-| 💬 对话推理 | `arkcli +chat` | 多模态对话（文本 / 图片 / 视频 / 音频），流式输出、多轮接续 |
-| 🎨 生图生视频 | `arkcli +gen` | Seedream 文生图 / 图生图、Seedance 文生视频 / 图生视频，产物自动下载 |
-| 🔍 多模态理解 | `arkcli +understand` | OCR、视觉定位（框选）、文档抽取、视频总结、语音转写 / 翻译、字幕打轴 |
-| 🚀 部署模型 | `arkcli +deploy` · `arkcli infer endpoint` | 一键把模型部署成在线推理接入点（Endpoint） |
-| 📋 模型 / 用量 / 账单 | `arkcli models` · `arkcli usage` · `arkcli billing` | 查公共基础模型、推理用量、结算账单 |
-| 🤖 注入 AI Agent | `arkcli +connect` | 把上面这些能力作为 Skill 装进本机的 AI Agent |
+```text
+帮我选择一个适合图文理解的模型，配置到本地 Agent，
+然后用它总结一段视频，并告诉我本月用了多少 token。
+```
 
-> 每个命令都自带 `--help`，例如 `arkcli +gen --help`。
+Agent 可以通过 Ark CLI 串起完整流程：
 
-## 快速开始
+```text
+arkcli models search
+  -> arkcli plans get / arkcli plans model-list
+  -> arkcli +connect / arkcli helper configure
+  -> arkcli +understand video-summary
+  -> arkcli usage stats / arkcli billing list
+```
 
-**环境要求**：Node.js ≥ 16（自带 npm / npx）·支持 macOS / Linux / Windows（arm64 / amd64）
+用户描述目标，Agent 负责选择命令、调用方舟能力、汇总结果。
 
+## 常用任务
+
+### 选择并调用模型
+
 ```shell
-# 1. 安装
-npm config set registry https://registry.npmjs.org/
-npm i -g @volcengine/ark-cli@latest
-arkcli --version
+arkcli +chat "总结一下 RAG 的核心思想"
 
-# 2. 登录（火山引擎 SSO，运行后在浏览器完成授权）
+arkcli +chat --input @photo.jpg "描述这张图片"
+
+arkcli +understand video-summary --input @demo.mp4 "按章节总结这个视频"
+
+arkcli +gen "生成一张未来城市海报"
+```
+
+### 开通和管理 Plan
+
+```shell
+# 查看当前账号持有哪些套餐
+arkcli plans get
+
+# 查看 Plan 支持哪些模型
+arkcli plans model-list --plan agent-plan
+
+# 查看团队版席位
+arkcli plans team seat-list --plan agent-plan-team
+
+# 查看本机 Agent 上 Plan 相关能力状态
+arkcli plans harness-status
+
+# 购买或续费前先查看参数
+arkcli plans buy --help
+arkcli plans renew --help
+```
+
+`plans buy` / `plans renew` 是计费操作，Ark CLI 会先展示协议和确认步骤，不会默认直接扣款。
+
+### 接入方舟服务能力
+
+`+connect` 安装 Ark Skills，让 Agent 知道有哪些方舟任务可以做。`helper` 配置 Harness / MCP / Plan，让 Agent 真正接上模型和工具能力。
+
+```shell
+# 查看会检测到哪些本地 Agent
+arkcli +connect list
+
+# 安装 Ark Skills
+arkcli +connect
+
+# 清理已注入的 Ark Skills
+arkcli +connect uninstall
+
+# 查看 Harness / Agent 配置状态
+arkcli helper list
+
+# 给当前 Agent 注入 MCP 工具能力
+arkcli helper mcp
+
+# 配置指定 Harness，并同步注入 MCP
+arkcli helper configure codex --with-mcp
+```
+
+`arkcli +connect uninstall` 会清理注入到本地 Agent 的 `ark-` / `arkcli-` 前缀 Skills，适合想恢复干净 Agent 环境、或担心 Skills 过多影响 Agent 路由时使用。它不会卸载 `arkcli` 命令本身。
+
+### 生产模型
+
+```shell
+arkcli train finetune --help
+arkcli train finetune capability get --model <model> --version <version>
+arkcli train finetune create --help
+arkcli train finetune watch <job-id>
+```
+
+### 上线服务
+
+```shell
+arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215 --dry-run
+arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215
+arkcli infer endpoint list
+arkcli infer endpoint get <endpoint-id>
+```
+
+### 管成本、状态和健康
+
+```shell
+arkcli usage plan
+arkcli usage stats --start 2026-07-01 --mine
+arkcli billing list --start 2026-07
+arkcli billing list --start 2026-07 --endpoint ep-xxx
+
+arkcli doctor
+arkcli doctor model <model-name>
+arkcli doctor infer-endpoint <endpoint-id>
+arkcli doctor metrics request.qpm
+arkcli doctor error ContentRiskBlocked
+```
+
+`doctor` 默认是只读诊断，不会修改资源。需要修复时会通过确认流程执行。
+
+## 命令入口
+
+| 任务 | 命令 |
+|---|---|
+| 对话和多模态推理 | `arkcli +chat` |
+| 图片 / 视频生成 | `arkcli +gen` |
+| OCR、视频总结、语音转写、文档抽取 | `arkcli +understand` |
+| 模型查询 | `arkcli models` |
+| Plan / 套餐管理 | `arkcli plans` |
+| Agent 接入和 Harness 配置 | `arkcli +connect`, `arkcli helper` |
+| 精调任务 | `arkcli train finetune` |
+| 一键部署 Endpoint | `arkcli +deploy` |
+| Endpoint 管理 | `arkcli infer endpoint` |
+| 用量查询 | `arkcli usage` |
+| 账单查询 | `arkcli billing` |
+| 诊断和自助排障 | `arkcli doctor` |
+
+每个命令都自带帮助：
+
+```shell
+arkcli +chat --help
+arkcli +gen --help
+arkcli +understand --help
+arkcli +deploy --help
+arkcli plans --help
+arkcli doctor --help
+```
+
+## 认证
+
+推荐使用火山 SSO：
+
+```shell
 arkcli auth login volc-sso
+```
+
+登录后 Ark CLI 会自动完成身份、profile 和 API Key 配置。你通常不需要手动复制密钥。
+
+```shell
 arkcli auth status
+arkcli auth apikey
+arkcli auth logout
+```
 
-# 3. 上手
-arkcli +chat "你好，介绍下你自己"
+## 配置
+
+```shell
+# 查看当前 profile
+arkcli profile show
+
+# 列出所有 profile
+arkcli profile list
+
+# 切换 profile
+arkcli profile use <profile-name>
 ```
 
-> **无浏览器环境**（CI / 远程开发机 / Agent 沙箱）：`arkcli auth login --no-browser`，在任意设备完成授权后用 `--code <码>` 粘回。
+更多 profile 管理能力可查看 `arkcli profile --help`。
 
-## 把能力装进你的 AI Agent
+## AI Agent Skills
 
+本仓库的 [`skills/`](https://github.com/volcengine/ark-cli/tree/main/skills) 收录了 Ark CLI 内置的 Agent Skills。执行：
+
 ```shell
@@ -84,15 +263,25 @@ arkcli +connect
 
-`+connect` 会自动检测本机的 AI Agent（Claude Code / OpenCode 等）并安装 Ark Skills。装好后，你在 Agent 里用**自然语言**就能驱动上面所有能力——“帮我生成一张图”“把这段录音转写成文字”“把某个模型部署成 Endpoint”。
+Ark CLI 会把这些 Skills 安装到本机 Agent，使 Agent 能通过自然语言调用火山方舟能力，包括对话、多模态理解、图片视频生成、模型查询、Plan 管理、Endpoint 部署、精调、用量、账单和诊断。
 
-## 浏览内置 Skills
+## 用户交流群
 
-本仓库的 [`skills/`](https://github.com/volcengine/ark-cli/tree/main/skills) 收录了 arkcli 全部内置 AI Agent Skills（对话 / 生成 / 理解 / 部署 / 模型 / 用量 / 账单 / 套餐 …），每个都是一份可读的 `SKILL.md`。`arkcli +connect` 装进你 Agent 的就是它们。
+扫码加入 Ark CLI 飞书用户交流群，获取使用答疑、问题排查、Bug 反馈和使用经验交流支持。你可以在群里咨询安装、登录、模型调用、Skill 使用、版本升级等问题，也欢迎反馈 GitHub Issues 中未覆盖的异常。
 
+请勿在群内发送 API Key、AK/SK、Token 等敏感信息。对于可稳定复现的 Bug，建议同步提交 GitHub Issue，便于跟踪和修复。
+
+<img src="./assets/lark-user-group.png" width="360" alt="Ark CLI 飞书用户交流群二维码" />
+
 ## 链接
 
-- 🌋 火山方舟控制台 & 文档：<https://www.volcengine.com/product/ark>
-- 📦 npm：<https://www.npmjs.com/package/@volcengine/ark-cli>
+- 火山方舟：<https://www.volcengine.com/product/ark>
+- npm：<https://www.npmjs.com/package/@volcengine/ark-cli>
+- GitHub Releases：<https://github.com/volcengine/ark-cli/releases>
+- 内置 Skills：<https://github.com/volcengine/ark-cli/tree/main/skills>
 
+## Changelog
+
+Release notes live in [GitHub Releases](https://github.com/volcengine/ark-cli/releases).
+
 ## License
 
 [Apache-2.0](./LICENSE)

New alerts

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Fixed alerts

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Improved metrics

Total package byte prevSize

31505

15.19%

Number of lines in readme file

285

196.88%

No dependency changes