You need to enable JavaScript to run this app.
文档中心
复制全文
下载 pdf
ArkCLI 命令参考
身份与配置
复制全文
下载 pdf
身份与配置
身份与配置:登录认证、本地配置、无交互引导,以及贯穿所有命令的 Profile 身份切面。​
  • auth 管 SSO 登录/登出与 ARK API Key;config 管本地 profile 配置与 update.mode 策略;​
  • profile 是 type × region × project × owner_trn × api_keys 五元组身份切面,是所有命令的配置中心来源;​
  • resources 只读,把 Endpoint 解析为权威模型与模态,是 Skills 与 API Explorer 的校准基线。​
auth​
认证与凭证管理:SSO 登录、查看登录状态、退出登录、生成/重选 ARK API Key。​
  • auth login 是交互式入口;无浏览器环境用 --no-browser 两段式(先取 URL,再回贴 base64 code);​
  • auth login volc-sso 是火山引擎 SSO 通道(0.1.16 起 SSO 登录自动绑定 profile 切面);​
  • 凭证存储位置是实现细节,业务代码一律通过 profile 的 cfg.APIKey 读取,不要直接访问存储。​
auth apikey​
获取并配置 ARK API Key​
​
arkcli auth apikey​
​
​
Flag​
类型​
说明​
--key-id​
int64​
指定要选择的 API Key ID(非交互模式用)​
​
auth apikey create​
创建并保存一把普通 ARK API Key​
​
arkcli auth apikey create​
​
​
Flag​
类型​
说明​
--yes​
bool​
跳过确认提示(非交互模式)​
​
auth login​
登录火山方舟平台(火山引擎)​
​
arkcli auth login​
​
​
Flag​
类型​
说明​
--code​
string​
无浏览器 Phase 2:把浏览器显示的 base64 授权码喂回以完成登录(agent/沙箱用)​
--credential-store​
string​
Broker verifier 存储后端:encrypted-file(默认,不访问 keyring)或 keyring(不可用时直接失败)​
--login-mode​
string​
登录模式:auto(新链路失败时按错误类型降级)、legacy(仅旧链路)、broker(仅新链路)​
--no-browser​
bool​
无浏览器模式:在任意设备完成 SSO 登录后手动粘贴授权码​
​
auth login volc-sso​
通过火山引擎 SSO 登录​
​
arkcli auth login volc-sso​
​
auth logout​
清除已保存的登录凭证​
​
arkcli auth logout​
​
​
Flag​
类型​
说明​
--reset-service-account​
bool​
(保留)​
​
auth status​
查看当前登录状态​
​
arkcli auth status​
​
auth whoami​
查看当前已认证的身份​
​
arkcli auth whoami​
​
config​
本地配置管理入口。profile 创建、查看、切换与删除已迁移到 profile 域。​
  • 保留能力:config reset(清整个本地状态,破坏性)、config set update.mode automatic|disabled(更新策略)、config lang;​
  • profile 归因、历史 yaml 排障等场景见 profile 域。​
config lang get​
打印当前生效的持久化 UI 语言​
​
arkcli config lang get​
​
config lang set​
持久化全局 UI 语言​
​
arkcli config lang set <locale>​
​
config lang unset​
清除持久化的 UI 语言,改用构建默认值​
​
arkcli config lang unset​
​
config reset​
删除所有本地配置文件​
​
arkcli config reset​
​
config set​
设置允许修改的全局配置项​
​
arkcli config set <key> <value>​
​
profile​
Profile 是 arkcli 在控制面与数据面之间的统一身份切面:type × region × project × owner_trn × api_keys 五元组绑成一组,作为所有命令执行的配置中心来源。​
  • 常用操作:列出/查看/新建/切换/删除/重命名,管理 profile 内 API Key 列表与各类默认资源;​
  • profile project 登录后重选 active project:project 相关 profile 重新派生,个人版 plan profile 原样保留,全程不换身份、不重登;​
  • 首登 project 选择器含「账号全部资源」合成项(默认),表示不设定 ProjectName、按账号全量。​
profile apikey get​
打印某个 profile 的默认 API Key 明文(机器可读)​
​
arkcli profile apikey get​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
--plain​
bool​
只打印 key 本身,不带 JSON 外层结构​
​
profile create​
新建 profile(交互式或行内参数)​
​
arkcli profile create​
​
​
Flag​
类型​
说明​
--name​
string​
Profile 名称(默认:{type}{region})​
--type​
string​
Profile 类型:platform | agent-plan | coding-plan | agent-plan-team | coding-plan-team​
--region​
string​
地域(默认:cn-beijing)​
--project​
string​
项目名称(默认:default)​
--default-api-key​
string​
要绑定的默认 API Key(可选)​
--owner-trn​
string​
Owner TRN(可选;自愈场景通常留空)​
--plan-tier​
string​
[仅套餐类型] 强制指定 PlanTier(agent-plan:small|medium|large|max;coding-plan:lite|pro);跳过 ListSubscribeTrade 的自动探测​
--set-default​
bool​
创建后把该 profile 设为默认​
--no-interactive​
bool​
跳过交互提示;缺少必填字段时立即失败​
​
profile delete​
删除 profile(非交互场景需用 --yes 确认)​
​
arkcli profile delete <profile>​
​
​
Flag​
类型​
说明​
--yes​
bool​
跳过交互确认(适合内联执行)​
​
profile apikey list​
列出当前或指定 profile 中的 API Key(脱敏)​
​
arkcli profile apikey list​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
​
profile apikey refresh​
从控制面重新拉取 API Key 列表并更新 profile​
​
arkcli profile apikey refresh​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
​
profile apikey use​
按 1 起始的序号(来自 apikey list)或完整 Key 设置默认 API Key​
​
arkcli profile apikey use <index|api-key>​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
​
profile list​
列出全部 profile(标记出当前生效的)​
​
arkcli profile list​
​
profile models list​
查看各模态的 PlanTier 与默认 Resources​
​
arkcli profile models list​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
​
profile models refresh​
重新拉取文本模型列表,并更新 Resources.Text.Default(取第一个)​
​
arkcli profile models refresh​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
​
profile project​
重新选择生效 project;会删除旧的 platform profile,并为新 project 新建一个​
​
arkcli profile project [<project-name>]​
​
​
Flag​
类型​
说明​
--yes​
bool​
跳过交互确认(适合内联执行)​
​
profile rename​
设置 profile 的显示名(可含中文与空格)​
​
arkcli profile rename <profile> --to <display-name>​
​
​
Flag​
类型​
说明​
--to​
string(必填)​
展示名称(可含中文/空格;空字符串表示清除标签)​
​
profile set-default​
为当前生效 profile 的某个模态设置默认资源 ID​
​
arkcli profile set-default <id>​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
--modality​
string​
模态:text | image | video​
--skip-verify​
bool​
跳过内联校验(绕过控制面可用性检查)​
​
profile show​
查看 profile 详情(密钥脱敏,含推导出的 base_url)​
​
arkcli profile show [profile]​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(位置参数的替代写法)​
​
profile use​
切换后续所有命令使用的生效 profile​
​
arkcli profile use [profile]​
​
resources​
实时控制面资源查询:列出当前/指定 profile 可见资源及其调用兼容性,并把 Endpoint 解析为权威模型、模态与候选工作流。​
  • 只读,不写 profile.yaml;拿到临时 ep-... 不确定该走 chat/understand/gen 时,先在本域 resolve;​
  • 是 Skills 与 API Explorer 的校准基线:返回的模型绑定与模态信息即真实可调用的契约。​
resources list​
列出当前生效 profile 可用的资源(实时查询,不走缓存)​
​
arkcli resources list​
​
​
Flag​
类型​
说明​
--profile​
string​
Profile 名称(默认:当前激活 profile)​
--modality​
string​
模态:text | image | video​
​
resources resolve​
把 Endpoint 解析为它绑定的模型、模态、API 与候选工作流​
​
arkcli resources resolve <endpoint-id>​
​
​
最近更新时间:2026.11.03 15:22:10
这个页面对您有帮助吗?
有用
有用
无用
无用