# Hermes Agent

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

本文介绍如何在 Hermes Agent 中配置并使用方舟 按量计费模型服务。

<span id="prerequisites"></span>
# 前提条件

* 在配置工具前，需要 [开通所需的模型服务](https://ark.volcengine.com/region:cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)。

* 支持在 macOS、Linux 和 Windows 系统中安装 Hermes Agent。

<span id="install-hermes-agent"></span>
# 安装 Hermes Agent

根据操作系统执行以下命令安装 Hermes Agent，安装过程中会检测并安装 uv、Python、Node.js、ripgrep、ffmpeg 等依赖，安装完成后重新加载 Shell 或终端。更多安装说明参见 [Hermes Agent 官方文档](https://hermes-agent.nousresearch.com/docs/getting-started/installation)。

**选项：macOS / Linux**

1. 执行以下 cURL 命令安装：

    ```Bash
    curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
    ```

2. 安装完成后重新加载 Shell。

    ```Bash
    source ~/.bashrc   # or: source ~/.zshrc
    ```

**选项：Windows**

1. 在 PowerShell 中执行以下命令安装：

    ```PowerShell
    iex (irm https://hermes-agent.nousresearch.com/install.ps1)
    ```

2. 安装完成后重新打开 PowerShell 窗口，或执行 `. $PROFILE` 刷新环境变量。

<span id="14207659"></span>
# 配置 Hermes Agent

<span id="configuration-information"></span>
## 需配置的信息

如您对 Hermes Agent 熟悉，或本地已有配置，可获取以下信息直接配置。

* **Base URL**：`https://ark.cn-beijing.volces.com/api/v3`。
* **API Key**：[获取API Key](https://ark.volcengine.com/region:cn-beijing/apikey)。
* **Model**：按需选择模型并获取 Model ID。可用模型参见[模型列表](/docs/model-list)。

<span id="method-2-manual"></span>
## 手动配置

按量计费模型服务兼容 OpenAI 接口协议，支持 Responses API、Chat API。推荐使用 Responses API 的配置，推理效果更好。

**选项：Responses API**

> **注意**
>
> 使用 Responses API，需要配置 `api_mode: codex_responses`。

执行以下命令配置 Hermes Agent，其中需要将 `<ARK_API_KEY>` 替换为您的 [API Key](https://ark.volcengine.com/region:cn-beijing/apikey)，并将 `<Model_ID>` 替换为需要使用的 Model ID。

```Bash
hermes config set model.provider custom
hermes config set model.base_url https://ark.cn-beijing.volces.com/api/v3
hermes config set model.api_key <ARK_API_KEY>
hermes config set model.default doubao-seed-evolving
hermes config set model.api_mode codex_responses
```

配置完成后，配置文件 `~/.hermes/config.yaml` 内容如下。您也可以直接编辑该配置文件。

```YAML
model:
  default: doubao-seed-evolving
  provider: custom
  base_url: https://ark.cn-beijing.volces.com/api/v3
  api_key: <ARK_API_KEY>
  api_mode: codex_responses
```

**选项：Chat API**

> **注意**
>
> 使用 Chat API，需要配置 `api_mode: chat_completions`。

执行以下命令配置 Hermes Agent，其中需要将 `<ARK_API_KEY>` 替换为您的 [API Key](https://ark.volcengine.com/region:cn-beijing/apikey)，并将 `<Model_ID>` 替换为需要使用的 Model ID。

```Bash
hermes config set model.provider custom
hermes config set model.base_url https://ark.cn-beijing.volces.com/api/v3
hermes config set model.api_key <ARK_API_KEY>
hermes config set model.default doubao-seed-evolving
hermes config set model.api_mode chat_completions
```

配置完成后，配置文件 `~/.hermes/config.yaml` 内容如下。您也可以直接编辑该配置文件。

```YAML
model:
  default: doubao-seed-evolving
  provider: custom
  base_url: https://ark.cn-beijing.volces.com/api/v3
  api_key: <ARK_API_KEY>
  api_mode: chat_completions
```

> **说明**
>
> * 如需使用 1M 上下文，直接选择支持 1M 上下文的模型，Hermes Agent 会自动完成调整，无需手动配置。
> * 若模型本身支持 1M 上下文，但 Hermes Agent 未正确识别，可在 `~/.hermes/config.yaml` 中手动添加或修改相应模型的 `context_length` 字段：`context_length: 1048576`。

<span id="start-hermes-agent"></span>
# 使用 Hermes Agent

1. 执行以下命令开启 Hermes Agent。

    ```Bash
    hermes
    ```

2. 开始使用 Hermes Agent，支持的 CLI Interface 参见 [官方文档](https://hermes-agent.nousresearch.com/docs/user-guide/cli)。