# Ark CLI：Coding Plan 个人版使用指南

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

Ark CLI 是火山方舟平台官方命令行工具，可在本地终端快捷配置与管理 Coding Plan 个人版的套餐和模型。

<span id="9066e158"></span>
# 一、安装和登录 ArkCLI

**环境要求：** Node.js >= 16

**选项：手动安装并登录**

<span id="d1e731f9"></span>
## 安装 Ark CLI

在终端执行以下命令：

```Bash
# 1. 通过 NPM 安装（下载最新版本）
npm install -g @volcengine/ark-cli@latest

# 2. 验证安装
arkcli --version
```

<span id="e0e22070"></span>
## 登录 Ark CLI

```Bash
# 登录方式
arkcli auth login

# 查看登录状态
arkcli auth status
```

**选项：通过 AI Agent 安装并登录**

将下方提示词复制给 AI Agent（Claude Code、Codex、Cursor、Trae 等），它会自动完成安装。

```Plain
根据下面命令帮我安装 Ark CLI：https://lf3-static.bytednsdoc.com/obj/eden-cn/psjryh/ljhwZthlaukjlkulzlp/intro/volc.md
```

<span id="897067d3"></span>
# 二、配置 Coding Plan
> 目前支持 Claude Code、Codex、OpenCode、OpenClaw、Trae 等主流工具，更多 Agent 陆续支持中。

在终端中输入命令 `arkcli helper`，根据 TUI 交互引导配置套餐、模型。

现以Coding plan个人版配置Claude Code为例：

![](https://arkdocs.tos-cn-beijing.volces.com/images/CodingPlan/cp-personal.gif)

<span id="c799b518"></span>
# 三、使用 ArkCLI

<span id="d3f63cc8"></span>
## 能力概览

ArkCLI 支持 Coding Plan 相关命令，覆盖**交易、配置、用量**三大范围，更多能力见 [ArkCLI 指南](/docs/ark-cli)。

- 交易：新购、续费、查询账号下套餐状态
- 配置：配置模型、查询套餐支持模型、查询配置状态
- 用量：余额查询、用量查询

<span id="e0a8c9ef"></span>
## 交易

**选项：通过 Agent 调用**

| 功能 | 示例提示词 |
| --- | --- |
| 新购套餐 | "我想买一个 Coding Plan 个人版 Pro，帮我下单" |
| 续费套餐 | "帮我续费一个月 Coding Plan" |
| 查询账号下套餐状态 | "我都订阅了哪些 Plan？是什么规格？" |

**选项：通过终端调用**

- 新购套餐：

  ```Bash
  # arkcli plans buy --plan <套餐名> --type <规格> [--duration <月数>] [--yes]

  # 参数说明：
  #     套餐名：coding-plan
  #     规格：lite/pro
  #     月数：1-12 月，例如：1，若不传该参数，默认 1 个月
  #     --yes：真实下单确认，若没有 --yes 仅返回订单预览与协议，建议先不加 --yes，预览订单

  # 示例命令：
  # 预览：只返回协议链接
  arkcli plans buy --plan coding-plan --type pro --duration 1
  # 真实下单
  arkcli plans buy --plan coding-plan --type pro --duration 1 --yes
  ```

- 续费：

  ```Bash
  # arkcli plans renew --plan <套餐名> [--duration <月数>] [--yes]

  # 参数说明：
  # 套餐名：coding-plan
  # 月数：1-12 月，例如：1，若不传该参数，默认 1 个月
  # --yes：真实下单确认，若没有 --yes 仅返回订单预览与协议，建议先不加 --yes，预览订单

  # 示例命令：
  # 预览：只返回协议链接
  arkcli plans renew --plan coding-plan --duration 1
  # 真实下单
  arkcli plans renew --plan coding-plan --duration 1 --yes
  ```

- 查询账号下套餐状态：

  ```Bash
  arkcli plans get
  ```

<span id="b4b4a12b"></span>
## 配置

| 功能 | 示例提示词 |
| --- | --- |
| 查询套餐支持的模型 | "Coding Plan Pro 支持哪些模型？" |

<span id="fd51788d"></span>
## 用量

| 功能 | 示例提示词 |
| --- | --- |
| 余额查询 | "我这个月 Coding Plan 还剩多少额度？" |
| 用量查询 | "我五小时额度还剩多少？" |
| Model 用量查询 | "我本周 doubao-seed-2.1-lite 用了多少额度？" |
