Skip to content
Back to search

ark-cli

The fastest way to put Volcengine Ark in your terminal and your AI agent — go from prompt to generated media, multimodal answer, or deployed endpoint in a single command, no API glue code.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/volcengine/ark-cli with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/volcengine/ark-cli'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/volcengine--ark-cli/badge.svg)](/listings/volcengine--ark-cli)

HTML

<a href="/listings/volcengine--ark-cli"><img src="/api/listings/volcengine--ark-cli/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 292 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. # Ark CLI
  3. **给你的 AI Agent 赋予火山方舟的全部能力**
  4. [![npm](https://img.shields.io/npm/v/@volcengine/ark-cli?color=brightgreen&label=npm)](https://www.npmjs.com/package/@volcengine/ark-cli)
  5. [![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
  6. [![node](https://img.shields.io/badge/node-%3E%3D16-brightgreen)](https://nodejs.org)
  7. 火山方舟模型、生成、多模态理解、Plan、精调、部署、用量、账单和诊断能力,都可以通过 Ark CLI + Skills 交给 Claude Code、OpenCode、Codex 等本地 Agent 调用。
  8. ```shell
  9. npm i -g @volcengine/ark-cli@latest
  10. ```
  11. </div>
  12. ---
  13. ## Ark CLI 能做什么
  14. 让你的 AI Agent 具备这些方舟能力,并能在复杂任务中组合调用:
  15. - **模型调用**:文本对话、多模态输入、流式输出、多轮接续
  16. - **图片 / 视频生成**:Seedream 生图、Seedance 生视频,产物自动下载到本地
  17. - **多模态理解**:OCR、视频总结、语音转写、字幕打轴、文档字段抽取
  18. - **Plan 管理**:Agent Plan / Coding Plan 查询、购买、续费、团队席位管理
  19. - **Agent 接入**:安装 Ark Skills,配置 Harness / MCP,让本地 Agent 调用方舟能力
  20. - **模型生产**:精调任务、自定义模型、训练状态跟踪
  21. - **服务上线**:基础模型或自定义模型一键部署为 Endpoint
  22. - **治理闭环**:Usage、Billing、Doctor、监控指标和错误码诊断
  23. ## 为什么需要 Ark CLI
  24. Ark CLI 不是让你记住更多命令,而是把火山方舟 MaaS 平台能力变成 Agent 可以调用的工具箱。
  25. ```text
  26. 消费链路:
  27. 选择模型
  28. -> 开通 Plan 或部署模型
  29. -> 接入本地 Agent / Harness
  30. -> 调用、理解、生成
  31. -> 查看用量、账单、监控和诊断结果
  32. 生产链路:
  33. 准备数据
  34. -> 创建精调任务
  35. -> 得到自定义模型
  36. -> 部署成 Endpoint
  37. -> 回到消费链路继续使用
  38. ```
  39. ## 安装与初始化
  40. ```shell
  41. # 1. 安装 CLI
  42. npm i -g @volcengine/ark-cli@latest
  43. arkcli --version
  44. # 2. 登录火山方舟
  45. arkcli auth login volc-sso
  46. arkcli auth status
  47. # 3. 同步 Ark Skills 到本地 Agent
  48. arkcli +connect
  49. ```
  50. 如只需 CLI,可在本次安装时跳过 Skills 下载和自动安装:
  51. ```shell
  52. ARKCLI_SKIP_SKILLS=1 npm i -g @volcengine/ark-cli@latest
  53. ```
  54. 该环境变量统一适用于所有产品的内外网 npm 安装,只有值为 `1` 时生效;默认行为不变。CLI 二进制仍正常下载、校验、安装和初始化,包内已有的 Skills 内容不会被移除。开关不保存配置、不删除已有 Skills,之后仍可手动运行 `arkcli +connect`。`ARKCLI_SKIP_POSTINSTALL=1` 会跳过整个安装钩子,不能用于只跳过 Skills。
  55. 无浏览器环境,例如远程开发机、CI 或 Agent 沙箱:
  56. ```shell
  57. arkcli auth login --no-browser
  58. arkcli auth login --no-browser --code <授权码>
  59. ```
  60. ## 一次完整任务可以这样开始
  61. 你可以直接告诉 Agent 一个目标:
  62. ```text
  63. 帮我选择一个适合图文理解的模型,配置到本地 Agent,
  64. 然后用它总结一段视频,并告诉我本月用了多少 token。
  65. ```
  66. Agent 可以通过 Ark CLI 串起完整流程:
  67. ```text
  68. arkcli models search
  69. -> arkcli plans get / arkcli plans model-list
  70. -> arkcli +connect / arkcli helper configure
  71. -> arkcli +understand video-summary
  72. -> arkcli usage stats / arkcli billing list
  73. ```
  74. 用户描述目标,Agent 负责选择命令、调用方舟能力、汇总结果。
  75. ## 常用任务
  76. ### 选择并调用模型
  77. ```shell
  78. arkcli +chat "总结一下 RAG 的核心思想"
  79. arkcli +chat --input @photo.jpg "描述这张图片"
  80. arkcli +understand video-summary --input @demo.mp4 "按章节总结这个视频"
  81. arkcli +gen "生成一张未来城市海报"
  82. ```
  83. ### 开通和管理 Plan
  84. ```shell
  85. # 查看当前账号持有哪些套餐
  86. arkcli plans get
  87. # 查看 Plan 支持哪些模型
  88. arkcli plans model-list --plan agent-plan
  89. # 查看团队版席位
  90. arkcli plans team seat-list --plan agent-plan-team
  91. # 查看本机 Agent 上 Plan 相关能力状态
  92. arkcli plans harness-status
  93. # 购买或续费前先查看参数
  94. arkcli plans buy --help
  95. arkcli plans renew --help
  96. ```
  97. `plans buy` / `plans renew` 是计费操作,Ark CLI 会先展示协议和确认步骤,不会默认直接扣款。
  98. ### 接入方舟服务能力
  99. `+connect` 安装 Ark Skills,让 Agent 知道有哪些方舟任务可以做。`helper` 配置 Harness / MCP / Plan,让 Agent 真正接上模型和工具能力。
  100. ```shell
  101. # 查看会检测到哪些本地 Agent
  102. arkcli +connect list
  103. # 安装 Ark Skills
  104. arkcli +connect
  105. # 清理已注入的 Ark Skills
  106. arkcli +connect uninstall
  107. # 查看 Harness / Agent 配置状态
  108. arkcli helper list
  109. # 给当前 Agent 注入 MCP 工具能力
  110. arkcli helper mcp
  111. # 配置指定 Harness,并同步注入 MCP
  112. arkcli helper configure codex --with-mcp
  113. ```
  114. `arkcli +connect uninstall` 会清理注入到本地 Agent 的 `ark-` / `arkcli-` 前缀 Skills,适合想恢复干净 Agent 环境、或担心 Skills 过多影响 Agent 路由时使用。它不会卸载 `arkcli` 命令本身。
  115. ### 生产模型
  116. ```shell
  117. arkcli train finetune --help
  118. arkcli train finetune capability get --model <model> --version <version>
  119. arkcli train finetune create --help
  120. arkcli train finetune watch <job-id>
  121. ```
  122. ### 上线服务
  123. ```shell
  124. arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215 --dry-run
  125. arkcli +deploy --name my-endpoint --model doubao-seed-2-0-pro-260215
  126. arkcli infer endpoint list
  127. arkcli infer endpoint get <endpoint-id>
  128. ```
  129. ### 管成本、状态和健康
  130. ```shell
  131. arkcli usage plan
  132. arkcli usage stats --start 2026-07-01 --mine
  133. arkcli billing list --start 2026-07
  134. arkcli billing list --start 2026-07 --endpoint ep-xxx
  135. arkcli doctor
  136. arkcli doctor model <model-name>
  137. arkcli doctor infer-endpoint <endpoint-id>
  138. arkcli doctor metrics request.qpm
  139. arkcli doctor error ContentRiskBlocked
  140. ```
  141. `doctor` 默认是只读诊断,不会修改资源。需要修复时会通过确认流程执行。
  142. ## 命令入口
  143. | 任务 | 命令 |
  144. |---|---|
  145. | 对话和多模态推理 | `arkcli +chat` |
  146. | 图片 / 视频生成 | `arkcli +gen` |
  147. | OCR、视频总结、语音转写、文档抽取 | `arkcli +understand` |
  148. | 模型查询 | `arkcli models` |
  149. | Plan / 套餐管理 | `arkcli plans` |
  150. | Agent 接入和 Harness 配置 | `arkcli +connect`, `arkcli helper` |
  151. | 精调任务 | `arkcli train finetune` |
  152. | 一键部署 Endpoint | `arkcli +deploy` |
  153. | Endpoint 管理 | `arkcli infer endpoint` |
  154. | 用量查询 | `arkcli usage` |
  155. | 账单查询 | `arkcli billing` |
  156. | 诊断和自助排障 | `arkcli doctor` |
  157. 每个命令都自带帮助:
  158. ```shell
  159. arkcli +chat --help
  160. arkcli +gen --help
  161. arkcli +understand --help
  162. arkcli +deploy --help
  163. arkcli plans --help
  164. arkcli doctor --help
  165. ```
  166. ## 认证
  167. 推荐使用火山 SSO:
  168. ```shell
  169. arkcli auth login volc-sso
  170. ```
  171. 登录后 Ark CLI 会自动完成身份、profile 和 API Key 配置。你通常不需要手动复制密钥。
  172. ```shell
  173. arkcli auth status
  174. arkcli auth apikey
  175. arkcli auth logout
  176. ```
  177. ## 配置
  178. ```shell
  179. # 查看当前 profile
  180. arkcli profile show
  181. # 列出所有 profile
  182. arkcli profile list
  183. # 切换 profile
  184. arkcli profile use <profile-name>
  185. ```
  186. 更多 profile 管理能力可查看 `arkcli profile --help`。
  187. ## AI Agent Skills
  188. 本仓库的 [`skills/`](https://github.com/volcengine/ark-cli/tree/main/skills) 收录了 Ark CLI 内置的 Agent Skills。执行:
  189. ```shell
  190. arkcli +connect
  191. ```
  192. Ark CLI 会把这些 Skills 安装到本机 Agent,使 Agent 能通过自然语言调用火山方舟能力,包括对话、多模态理解、图片视频生成、模型查询、Plan 管理、Endpoint 部署、精调、用量、账单和诊断。
  193. ## 用户交流群
  194. 扫码加入 Ark CLI 飞书用户交流群,获取使用答疑、问题排查、Bug 反馈和使用经验交流支持。你可以在群里咨询安装、登录、模型调用、Skill 使用、版本升级等问题,也欢迎反馈 GitHub Issues 中未覆盖的异常。
  195. 请勿在群内发送 API Key、AK/SK、Token 等敏感信息。对于可稳定复现的 Bug,建议同步提交 GitHub Issue,便于跟踪和修复。
  196. <img src="./assets/lark-user-group.png" width="360" alt="Ark CLI 飞书用户交流群二维码" />
  197. ## 链接
  198. - 火山方舟:<https://www.volcengine.com/product/ark>
  199. - npm:<https://www.npmjs.com/package/@volcengine/ark-cli>
  200. - GitHub Releases:<https://github.com/volcengine/ark-cli/releases>
  201. - 内置 Skills:<https://github.com/volcengine/ark-cli/tree/main/skills>
  202. ## Changelog
  203. Release notes live in [GitHub Releases](https://github.com/volcengine/ark-cli/releases).
  204. ## License
  205. [Apache-2.0](./LICENSE)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.