# 工具与平台

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

接入与工具：把方舟能力配置进第三方 Agent、安装内嵌 Skills、生成调用示例、原始 API 兜底，以及 CLI 自升级与体验入口。

- `helper` 配置 model/provider 与 Harness 工具能力；`+connect` 安装二进制内嵌 Skills；`+code-example` 生成多语言调用示例；
- `api` 是已注册 Action 的兜底通道，先用产品命令、覆盖不到再用；
- `update` 只响应显式调用，无静默升级；`exp` 是 Volc 专属的交互式 TUI 体验入口。

<span id="code-example-command"></span>
## +code-example

为指定基础模型生成多语言（Python / Go / Java / Node / curl）调用示例代码并写入本地文件。

```Bash
arkcli +code-example
```

示例：

```Bash
arkcli +code-example \
  --model doubao-seedream-5-0 \
  --language python \
  --format json
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--model` | string（必填） | 基础模型名称或捆绑 id（如 doubao-seedream-5-0 或 doubao-seedream-5-0-260128） |
| `--version` | string | 基础模型版本（如 260128）；若 --model 已带版本则省略 |
| `--language` | string | 按语言过滤：python、go、java、node、curl（默认全部） |
| `--lang` | string | --language 的已废弃别名；在本命令上选择 UI 语言请用根命令的 --ui-lang |
| `--output-dir` | string | 示例文件输出目录（默认：./ark-examples/<model>） |

<span id="connect-command"></span>
## +connect

把 arkcli 内置 AI skills 安装到本机检测到的所有 AI Agent

```Bash
arkcli +connect
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--path` | string | 把 arkcli skills 安装到指定的本地 skills 目录，而不是自动探测的全局 agent 目录；相对路径基于当前工作目录解析 |
| `--refresh` | bool | 对外版:先从 CDN(首选)/ GitHub(兜底)重新下载最新 skill 再安装(内场版 skill 已内嵌,此标志为空操作) |
| `--keep-conflicting` | bool | 保留会劫持 +gen 路由的第三方生成技能（byted-ark-seedance/seedream）；默认 +connect 会把它们从各 Agent 目录中移除 |

<span id="connect-list-command"></span>
### +connect list

列出支持的 AI Agent 及检测状态

```Bash
arkcli +connect list
```

<span id="connect-uninstall-command"></span>
### +connect uninstall

从检测到的 AI Agent 中卸载 arkcli AI skills

```Bash
arkcli +connect uninstall
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--path` | string | 只从指定的本地 skills 目录卸载 arkcli skills，而不是自动探测的全局 agent 目录；相对路径基于当前工作目录解析 |
| `--purge-prefix` | bool | 破坏性删除所有以 ark-/arkcli- 为前缀的目录或软链接，包括非 ArkCLI 管理的条目 |

<span id="api-command"></span>
## api

已注册 Action 的原始 API 浏览器

```Bash
arkcli api [registered-action]
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--dry-run` | bool | 预览客户端执行计划，不发网络请求、无副作用 |
| `--list` | bool | 列出全部已注册的 API Action |
| `--params` | string | JSON 请求体 |

<span id="exp-command"></span>
## exp

启动方舟体验 TUI

```Bash
arkcli exp
```

<span id="exp-uninstall-command"></span>
### exp uninstall

卸载方舟体验 TUI

```Bash
arkcli exp uninstall
```

<span id="helper-command"></span>
## helper

交互向导：把本机 AI Agent 配置到 Platform Endpoint 或受支持的 Plan

```Bash
arkcli helper
```

<span id="helper-configure-command"></span>
### helper configure

非交互配置单个 harness 到 Platform Endpoint 或受支持的 Plan

```Bash
arkcli helper configure <harness>
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--profile` | string | 目标 Platform / Plan profile（默认当前 active） |
| `--model` | string | Plan model ID（默认取该 plan 选中/首个模型；Platform 不可用） |
| `--endpoint` | string | 已验证的 Platform 文本 Endpoint ID（仅 Platform profile 必填） |
| `--codex-config-scope` | string | (仅 Codex)配置范围:profile(默认,写 ~/.codex/arkcli.config.toml)\|global(写 ~/.codex/config.toml) |
| `--codex-profile` | string | (仅 Codex profile 模式)Codex profile 名,默认 arkcli |
| `--dsh-config-scope` | string | (仅 DSH)配置范围:home(默认,写 $DSH_HOME/cordis.patch.yml)\|profile(写 $DSH_HOME/profiles/<name>/cordis.patch.yml,需 --dsh-profile) |
| `--dsh-profile` | string | (仅 DSH)profile scope 的 DSH profile 名 |
| `--with-mcp` | bool | 同时注入 Agent Plan 内置 MCP(豆包搜索 + dataPro + OpenViking;仅 Agent Plan 含团队版、且支持 MCP 的 harness 生效) |
| `--keep-native-websearch` | bool | 保持原生 WebSearch 开启 |
| `--with-cua` | bool | 同时安装云电脑(CUA)skill(仅 Agent Plan 个人版 Medium/Large/Max;一次性装给所有已安装的 AI Agent;失败只 warn) |
| `--with-routing` | bool | 启用 Agent Plan 强制搜索路由（同时配置所选业务 MCP） |
| `--with-supabase` | bool | 同时装 byted-supabase CLI+Skill 并注入火山登录态(仅 Agent Plan 家族;个人版全档 + 团队版全档;与 harness 无关、失败只 warn) |

<span id="helper-list-command"></span>
### helper list

列出支持的 AI Agent 及其安装状态、配置路径

```Bash
arkcli helper list
```

<span id="helper-mcp-command"></span>
### helper mcp

为目标 agent 配置 Agent Plan Harness 工具;默认配置整组 MCP(豆包搜索 + DataPro + OpenViking),可用 --capability 只配单项。不传 target 自动检测;不改模型

```Bash
arkcli helper mcp [target]
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--capability` | string | 只配置一项 Harness 能力:cua \| datapro \| web-search \| agent-memory(不传则保持整组 MCP 旧行为) |
| `--profile` | string | 指定 Agent Plan profile(默认自动定位账号下的 agent-plan / agent-plan-team profile,与当前 active profile 无关) |
| `--ov-resource` | string | 指定 OpenViking 库(按库名;账号有多个库时必填,不填会报错列出可选库名) |
| `--scope` | string | MCP 写入范围:global(默认,用户级 ~/.trae/mcp.json 等)\| project(仅 Trae,写当前目录 ./.trae/mcp.json) |
| `--codex-config-scope` | string | (仅 Codex)配置范围:profile(默认,写 ~/.codex/arkcli.config.toml)\|global(写 ~/.codex/config.toml) |
| `--codex-profile` | string | (仅 Codex profile 模式)Codex profile 名,默认 arkcli |
| `--dsh-config-scope` | string | (仅 DSH)配置范围:home(默认,写 $DSH_HOME/cordis.patch.yml)\|profile(写 $DSH_HOME/profiles/<name>/cordis.patch.yml,需 --dsh-profile) |
| `--dsh-profile` | string | (仅 DSH)profile scope 的 DSH profile 名 |
| `--keep-native-websearch` | bool | 保持原生 WebSearch 开启 |

<span id="helper-reset-command"></span>
### helper reset

移除 arkcli 为某 harness 注入的配置(含 MCP),保留用户其它设置

```Bash
arkcli helper reset <claude-code|codex|deepseek-harness|pi|opencode|openclaw|hermes|trae|zcode|kimi-code|cursor|grok|workbuddy>
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--scope` | string | (仅 Trae)移除范围:global(默认,~/.trae/mcp.json)\| project(./.trae/mcp.json) |
| `--codex-config-scope` | string | (仅 Codex)移除范围:profile(默认,~/.codex/arkcli.config.toml)\|global(~/.codex/config.toml) |
| `--codex-profile` | string | (仅 Codex profile 模式)Codex profile 名,默认 arkcli |
| `--dsh-config-scope` | string | (仅 DSH)配置范围:home(默认,写 $DSH_HOME/cordis.patch.yml)\|profile(写 $DSH_HOME/profiles/<name>/cordis.patch.yml,需 --dsh-profile) |
| `--dsh-profile` | string | (仅 DSH)profile scope 的 DSH profile 名 |

<span id="helper-supabase-command"></span>
### helper supabase

装 byted-supabase-cli + skill 并注入火山 Agent Plan 登录态(打通 byted-supabase 数据库能力);仅 Agent Plan(个人版全档 + 团队版全档)

```Bash
arkcli helper supabase
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--profile` | string | 指定 Agent Plan profile(默认自动定位账号下的 agent-plan / agent-plan-team profile,与当前 active 无关) |

<span id="update-command"></span>
## update

升级 arkcli 到最新稳定版本

```Bash
arkcli update
```

| Flag | 类型 | 说明 |
| --- | --- | --- |
| `--check` | bool | 只检查是否有新版本, 不执行升级 |
| `--refresh` | bool | 配合 --check: 强制联网查询最新版本 (默认只读本地缓存) |
| `--yes` | bool | 跳过交互确认, 直接升级 |