# WorkBuddy
> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。
WorkBuddy 是腾讯云推出的桌面 AI 智能体客户端，适配 QQ / 企微生态。本文介绍如何在 WorkBuddy 中接入方舟 Agent Plan 使用。
# 一、前提条件
* 您已按需订阅 Agent Plan 套餐。如未，请访问 [开通管理-Agent Plan](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan?agentMode=close) 页面订阅套餐。
- 访问 [WorkBuddy 官网](https://www.workbuddy.ai/)，下载并安装适合您操作系统的版本。安装完成后按提示登录。
# 二、配置 WorkBuddy
## 方式 1：自动化助手（推荐）
ArkCLI Helper 是一个编码工具助手，支持快速配置选择的工具接入 Agent 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
```
根据界面提示选择登录方式。若之前已登录过 arkcli，会沿用上次选择的配置；如需重新选择，请先执行 `arkcli config reset` 后再运行 `arkcli auth login`。首次登录时，按提示完成以下配置：
1. **选择项目（Project）**：可按需选择，或默认选择**账号全部资源**。
2. **选择消费模式（Type）**：选择 `agent-plan`。
其中：
* ``：运行 ArkCLI Helper 时填写的 Agent Plan 专属 API Key。
3. 运行 ArkCLI Helper，根据界面提示完成 WorkBuddy 的配置。
1. 在命令行界面输入 `arkcli helper` 命令，启动 ArkCLI Helper。
运行过程中会提示填写 Agent Plan 专属 API Key；如需在本地环境变量中管理，可使用 `ARK_API_KEY` 作为变量名。
2. **选择要配置的 Plan profile**：`agent-plan_cn-beijing_personal (Agent Plan)`。
3. **选择默认 model**：按需选择。
4. **选择要配置的 AI Agent**：`WorkBuddy`。
当前支持的 Harness 包括：豆包搜索、专业数据集、Agent 记忆（OpenViking）、AI Native 应用开发底座，根据界面提示按需选择`配置`或者`跳过`。
完成上述操作后，将自动完成 WorkBuddy 的基础配置，并按选择结果自动安装对应的 Harness 工具，无需手动安装。
## 方式 2：手动配置
1. 启动 WorkBuddy，单击左下角账户头像，选择 **设置**。
2. 在左侧导航中选择 **模型**，在自定义模型区域单击 **添加模型**。
3. 在提供商中选择 **自定义 / Custom**，填写以下字段并保存：
* **接口地址**：`https://ark.cn-beijing.volces.com/api/plan/v3`
* **API Key**：请在 [Agent Plan 页面](https://ark.volcengine.com/region:cn-beijing/subscription/agent-plan) 使用 **Agent Plan 专属 API Key**。
* **模型名称**：填写所选套餐支持的 Model Name，模型信息见 [支持模型及 Harness](/docs/agent-plan-personal-plan-overview#3d801f5f)，需配置文本生成模型。
* **高级工具**：非必填，按需勾选。建议开启 **工具调用**、**图片输入**、**思考模式**。
* **自定义协议**：当模型服务使用非标准 URL 路径（如经过网关或代理层封装）时，可在高级配置中开启自定义协议开关。开启后 Tencent WorkBuddy 将直接按填写的 URL 发起请求，跳过路径校验与自动补全。关闭（默认）：使用标准 `/chat/completions` 路径，自动校验并补全接口地址。开启：直接使用用户填写的接口地址发起请求，跳过路径校验与自动补全逻辑。
除了在客户端 UI 中添加自定义模型，也可以直接编辑本地配置文件 `~/.workbuddy/models.json` 来接入 Agent，保存后，WorkBuddy 会自动监听并热加载新配置（**无需重启**）。返回主界面的模型下拉列表中显示的即为 `name` 字段。
`~/.workbuddy/models.json` 示例
```JSON
[
{
"id": "doubao-seed-evolving",
"name": "Doubao Seed Evolving",
"vendor": "Custom",
"url": "https://ark.cn-beijing.volces.com/api/plan/v3",
"apiKey": "",
"supportsToolCall": true,
"supportsImages": false,
"supportsReasoning": false,
"useCustomProtocol": false
}
]
```
4. 保存后返回 WorkBuddy 主界面。
# 三、使用 WorkBuddy
1. 在主界面顶部的模型下拉中，选中刚添加的模型。
2. 在输入框用一句话描述你的任务（如生成周报、数据分析、整理文件、代码生成 / 重构 / 修 Bug），回车即可启动，WorkBuddy 会自主规划执行并产出文档、表格、代码文件等结果，在右侧结果区可查看生成内容与文件变更。
> 更多使用技巧和场景参见 [WorkBuddy 官方文档](https://www.workbuddy.ai/docs/zh/workbuddy/Quickstart)。