# 快速开始

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

本文介绍如何在编程工具中快速使用 Coding Plan 套餐所支持的模型进行代码开发。

<span id="61e3b838"></span>
# 核心配置

接入工具的核心参数如下：
<span id="3a775131"></span>
## **模型配置**

支持以下两种方式配置模型：

**选项：配置 Model Name (配置文件指定)**

在工具配置文件中指定 Model Name，可实时切换模型。支持配置的 Model Name：

> **注意**
>
> 配置 Model Name 时，支持使用全小写格式，同时也支持直接复制 [开通管理页面](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&advancedActiveKey=subscribe) 中的模型名称。

* `doubao-seed-evolving`
* `doubao-seed-2.1-pro`
* `doubao-seed-2.1-lite`
* `doubao-seed-2.0-mini`
* `minimax-m3`
* `glm-5.3` (`glm-latest`)
* `glm-5.3-flash`
* `deepseek-v4.1-flash`
* `deepseek-v4-flash`
* `deepseek-v4-pro`
* `kimi-k2.8-preview`
* `kimi-k3`

> **说明**
>
> Model Name 不支持配置为 `Auto`，如需使用，请通过控制台切换该模式。

**选项：配置 ark-code-latest (控制台管理)**

1. 在配置文件中指定模型为`ark-code-latest`。
2. 通过 [开通管理页面](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&advancedActiveKey=subscribe) 选择或切换目标模型，切换模型后 3-5 分钟即可生效。
     支持 Auto 模式，通过「效果 + 速度」双维度智能算法自动选择模型。

<span id="7fd1eee7"></span>
## **Base URL**

不同的工具配置的 Base URL 根据兼容的协议会有不同：
* 兼容 Anthropic 接口协议工具：`https://ark.cn-beijing.volces.com/api/coding`
* 兼容 OpenAI 接口协议工具：`https://ark.cn-beijing.volces.com/api/coding/v3`

> **注意**
>
> 请勿使用 `https://ark.cn-beijing.volces.com/api/v3` ：该 Base URL 不会消耗您的 Coding Plan 额度，而是会产生额外费用。

<span id="f05bb565"></span>
## **API Key**

[获取 API Key](https://ark.volcengine.com/region:cn-beijing/apikey)

<span id="a3758e4d"></span>
# 步骤一：订阅方舟 Coding Plan

访问 [方舟 Coding Plan 活动](https://www.volcengine.com/activity/codingplan)，按需订阅套餐。套餐介绍请参见[套餐概览](/docs/coding-plan-personal-plan-overview)。

<span id="c5311898"></span>
# 步骤二：配置编程工具

Coding Plan 支持主流的编程工具，可按需选择。

**[Claude Code](/docs/coding-plan-personal-ai-claude-code)**
AI 终端编程助手，自然语言编程

**[TraeCode](/docs/coding-plan-personal-ai-trae)**
智能 IDE，构建新一代编程工作流

**[Roo Code](/docs/coding-plan-personal-ai-other-tools)**
轻量级编程助手

**[Codex CLI](/docs/coding-plan-personal-ai-codex)**
OpenAI 推出的命令行编程工具

**[OpenCode](/docs/coding-plan-personal-ai-opencode)**
开源 AI 编程代理工具

**[Cline](/docs/coding-plan-personal-ai-other-tools)**
VSCode 扩展，代码补全和调试

**[Kilo Code](/docs/coding-plan-personal-ai-other-tools)**
轻量高性能编程工具

**[OpenClaw](/docs/coding-plan-personal-ai-openclaw)**
开源、自托管个人 AI 助手 

**[Cursor](/docs/coding-plan-personal-ai-other-tools)**
AI 原生代码编辑器

**[Hermes Agent](/docs/coding-plan-personal-ai-hermes-agent)**
开源自主 AI 智能体

下面以 Claude Code 为例介绍如何使用 Coding Plan。

<span id="037e332e"></span>
## 安装 Claude Code

前提条件：
* 安装 [Node.js 18 或更新版本环境](https://nodejs.org/en/download/)。
* Windows 用户需安装 [Git for Windows](https://git-scm.com/download/win)。

在命令行界面，执行以下命令安装 Claude Code。

```Bash
npm install -g @anthropic-ai/claude-code
```

安装结束后，执行以下命令查看安装结果，若显示版本号则安装成功。

```Bash
claude --version
```

<span id="2bfb05a3"></span>
## 配置工具

<span id="3487df77"></span>
### 方式一：自动化助手（推荐）

ArkCLI Helper 是一个编码工具助手，支持快速配置选择的工具接入 Coding Plan。安装并运行该助手，根据界面提示操作可自动完成工具配置，降低手动配置的时间成本和出错风险。 

> **注意**
>
> * ArkCLI Helper 是基于 Ark Helper 升级演进的工具配置服务，相关能力将持续在 ArkCLI Helper 上迭代更新。建议优先使用 ArkCLI Helper 完成工具配置。
> * ArkCLI Helper 支持 macOS、Linux、Windows 系统。

1. 安装 Ark CLI。

    ```Bash
    # 1. 通过 NPM 安装
    npm install -g @volcengine/ark-cli@latest
    
    # 2. 验证安装
    arkcli --version
    ```

2. 登录 Ark CLI。

    ```Bash
    arkcli auth login
    ```

    ![image-20260624-144256-509.png](https://arkdocs.tos-cn-beijing.volces.com/images/CodingPlan/image-20260624-144256-509.png)

    根据界面提示选择登录方式。若之前已登录过 arkcli，会沿用上次选择的配置；如需重新选择，请先执行 `arkcli config reset` 后再运行 `arkcli auth login`。首次登录时，按提示完成以下配置：

    1. **选择项目（Project）**：可按需选择，或默认选择**账号全部资源**。
    2. **选择消费模式（Type）**：选择 `coding-plan`。

        ![image-20260624-163746-727.png](https://arkdocs.tos-cn-beijing.volces.com/images/CodingPlan/image-20260624-163746-727.png)

3. 运行 ArkCLI Helper，根据界面提示完成 Claude Code 的配置。

    1. 在命令行界面输入 `arkcli helper` 命令，启动 ArkCLI Helper。
    2. **选择要配置的 Plan profile**：选择 `coding-plan_cn-beijing_personal (Coding Plan)`。

        ![image-20260624-163451-813.png](https://arkdocs.tos-cn-beijing.volces.com/images/CodingPlan/image-20260624-163451-813.png)

    3. **选择默认 model**：按需选择。
    4. **选择要配置的 AI Agent**：`Claude Code`。

        ![image-20260624-163912-096.png](https://arkdocs.tos-cn-beijing.volces.com/images/CodingPlan/image-20260624-163912-096.png)

完成上述操作后，将自动完成 Claude Code 的基础配置，无需手动安装。

<span id="561a3715"></span>
### 方式二：手动配置

完成Claude Code安装后，配置以下信息。
* **ANTHROPIC_BASE_URL**：`https://ark.cn-beijing.volces.com/api/coding`
* **ANTHROPIC_AUTH_TOKEN**：[获取 API Key](https://ark.volcengine.com/region:cn-beijing/apikey)
* **ANTHROPIC_MODEL**: 支持配置 Model Name （实时切换模型）、配置`ark-code-latest`（控制台切换模型）两种方式，具体见 [模型配置](/docs/coding-plan-personal-get-started#3a775131)。

配置步骤如下：
1. 创建并打开 `settings.json` 配置文件。文件路径因系统而异，具体操作如下：

    **选项：macOS/Linux**

    macOS/Linux 系统 Claude Code 配置文件路径：`~/.claude/settings.json`。
    1. 如果在主目录下没有`.claude`目录，执行以下命令创建目录。

        ```Bash
        mkdir -p ~/.claude
        ```

    2. 创建并打开配置文件。

        ```Bash
        nano ~/.claude/settings.json
        ```

    **选项：Windows**

    Windows 系统 Claude Code 配置文件路径：`C:\Users\<用户名>\.claude\settings.json`。以 CMD 命令行方式为例，操作如下。
    1. 如果当前用户目录下没有`.claude`目录，执行以下命令创建目录。

        ```Bash
        if not exist "%USERPROFILE%\.claude" mkdir "%USERPROFILE%\.claude"
        ```

    2. 创建并打开配置文件。

        ```Bash
        notepad "%USERPROFILE%\.claude\settings.json"
        ```

2. 编辑配置文件，需要修改的配置信息如下：

    * `<ARK_API_KEY>`：替换为您自己的 [API Key](https://ark.volcengine.com/region:cn-beijing/apikey)。

    * `<Model_Name>`：更新为需要使用的模型信息，如`ark-code-latest`。支持的模型信息参见 [模型配置](/docs/coding-plan-personal-get-started#3a775131)。

    ```JSON
    {
        "env": {
            "ANTHROPIC_AUTH_TOKEN": "<ARK_API_KEY>",
            "ANTHROPIC_BASE_URL": "https://ark.cn-beijing.volces.com/api/coding",
            "ANTHROPIC_MODEL": "<MODEL_NAME>",
            "ANTHROPIC_DEFAULT_HAIKU_MODEL": "<MODEL_NAME>",
            "ANTHROPIC_DEFAULT_SONNET_MODEL": "<MODEL_NAME>",
            "ANTHROPIC_DEFAULT_OPUS_MODEL": "<MODEL_NAME>",
            "CLAUDE_CODE_SUBAGENT_MODEL": "<MODEL_NAME>",
            "CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC": "1"
        }
    }
    ```

> **说明**
>
> * 要开启 1M 上下文窗口，配置参见[扩展上下文](/docs/coding-plan-personal-ai-claude-code#7a3e5c1b)。
> * 推荐使用完整模型配置，并按任务复杂度选择模型：Haiku（轻量）、Sonnet（日常）、Opus（复杂）。
> * `CLAUDE_CODE_SUBAGENT_MODEL` 建议与主模型保持一致。
> * `ANTHROPIC_DEFAULT_HAIKU_MODEL` 建议设置为小尺寸模型，通常不会影响整体使用效果。
> * `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC` 用于关闭 Claude Code 后台匿名遥测请求。遥测请求默认会走 `ANTHROPIC_BASE_URL` 并占用 Coding Plan 配额，设为 `"1"` 可避免额度被静默消耗（方式 1 的 ArkCLI Helper 会自动配置此项）。

3. 编辑或新增 `.claude.json` 文件，修改或新增 `hasCompletedOnboarding` 字段值为 true。

    1. 不同系统`.claude.json`配置文件路径如下：

        * macOS/Linux：`~/.claude.json`

        * Windows：`C:\Users\<用户名>\.claude.json`

    2. 修改或新增的字段信息如下：

        ```JSON
        {
          "hasCompletedOnboarding": true
        }
        ```

保存配置文件后，在新的终端窗口执行后续命令。

<span id="a351e130"></span>
## 使用 Claude Code

1. 启动 Claude Code：进入项目目录，执行`claude`命令，即可开始使用 Claude Code。

    ```Bash
    cd my-project
    claude
    ```

    启动后，选择信任此文件夹，允许 Claude Code 访问该文件夹中的文件。
2. 模型状态验证：输入`/status`确认模型状态。

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/4382021492134eee946601bf53514b48~tplv-goo7wpa0wc-image.image)

3. 在 Claude Code 中对话。

> **注意**
>
> [Claude Code 如何开启深度思考模式？](/docs/coding-plan-personal-faq#1c6446b6)

![](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/631742d8a5814d68a5cbc62988ba8cab~tplv-goo7wpa0wc-image.image)

<span id="f2fb050d"></span>
## 切换模型

请根据模型配置方式，选择对应的模型切换方案。

|配置方式 |配置`ark-code-latest` |配置 Model Name |
|---|---|---|
|切换模型操作 |1. 在 [开通管理页面](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&advancedActiveKey=subscribe) 选择要使用的模型，切换后3-5分钟即可生效。 |* 启动时：执行`claude --model <Model_Name>`，可指定对应的模型。 | \
| |2. 在命令行窗口，启动 Claude Code 后，输入`/status`确认模型状态。 |* 对话期间：执行`/model <Model_Name>`切换模型。 |

<span id="98f1b16e"></span>
# 常见问题

[常见问题](/docs/coding-plan-personal-faq)

<span id="904b34ad"></span>
# 错误码

如遇报错，可根据错误信息查看错误码说明，定位&解决问题。详细信息请参见[错误码](/docs/error-codes)。
