You need to enable JavaScript to run this app.
文档中心
复制全文
下载 pdf
ADrive 命令行工具
快速使用 ve-adrive-cli
复制全文
下载 pdf
快速使用 ve-adrive-cli
本章节介绍如何快速使用 ve-adrive-cli。​
安装指引​
​
包管理器安装
Shell 一键安装
源码构建
作为 SKILL 安装 for AI-Agent
​
  • 通过 npm 安装:​
  • ​
    npm install -g ve-adrive-cli​
    ​
  • 通过 pip 安装:​
  • ​
    pip install ve-adrive-cli​
    ​
  • macOS 上通过 Homebrew 安装(依次运行如下三个命令):​
  • ​
    brew tap volcengine/ve-storage-uni-cli https://github.com/volcengine/ve-storage-uni-cli​
    ​
    brew trust volcengine/ve-storage-uni-cli​
    ​
    brew install ve-adrive-cli​
    ​
  • 通过 cargo 安装:​
  • ​
    cargo install ve-adrive-cli​
    ​
​
​
快速开始​
完成安装后,可按以下步骤完成初始化、凭证注入与首次调用验证。​
  1. 配置地域与 endpoint。​
  • 通过 config set 命令写入本地配置文件,指定后续请求使用的地域 region 和服务访问地址 endpoint。​
  • ​
    ve-adrive-cli config set region cn-beijing​
    ve-adrive-cli config set endpoint https://ids-cn-beijing.volces.com​
    ​
  1. 配置凭证。​
  • 通过环境变量传入访问凭证。ADRIVE_ACCESS_KEY 和 ADRIVE_SECRET_KEY 为必填项,ADRIVE_SECURITY_TOKEN 用于 STS 临时凭证场景(可选)。若仅配置 ADRIVE_REGION,CLI 将按规则自动推导出 https://ids-<region>.volces.com,无需手动指定。​
  • ​
    export ADRIVE_ACCESS_KEY=<your-adrive-access-key-id>​
    export ADRIVE_SECRET_KEY=<your-adrive-secret-access-key>​
    export ADRIVE_SECURITY_TOKEN=<optional-sts-token>​
    ​
  1. 配置文件。​
  • 默认配置文件为 $HOME/.tos/config.toml。​
  • 您可以通过 --config-path 或环境变量 TOS_CONFIG_PATH 指定配置文件路径。​
  • 该目录同时存放保护落盘密钥的本地加密 key。​
  • ADrive 专属配置写入 [profile.adrive]。共享的 region、endpoint 和凭证字段会被忽略。​
说明​
如果显式指定的配置文件不存在,运行类命令会直接报错,退出码为 3。​
  1. 查看和初始化配置。​
  • 您可以使用以下命令查看或初始化配置。​
  • ​
    ve-adrive-cli config init​
    ve-adrive-cli config show --output json​
    ve-adrive-cli config set region cn-beijing​
    ve-adrive-cli config set endpoint https://ids-cn-beijing.volces.com​
    ​
  1. 常见工作流。​
  • ​
    # 查看当前实例支持的能力分组列表​
    ve-adrive-cli capabilities --view groups​
    # 以表格形式列举指定路径下的文件和目录​
    ve-adrive-cli ls adrive://instance/space/path/ --output table​
    # 模拟将本地文件 local.txt 上传至指定路径(不实际执行,仅预览操作结果)​
    ve-adrive-cli cp ./local.txt adrive://instance/space/local.txt --dry-run​
    # 递归上传本地目录 dir 至 backup/ 路径,并保留父目录结构​
    ve-adrive-cli cp ./dir adrive://instance/space/backup/ --recursive --include-parent​
    ​
全局参数​
​
选项​
说明​
-P, --profile <PROFILE>​
配置 profile 名称。​
--config-path <PATH>​
配置 TOML 文件路径(env TOS_CONFIG_PATH)。​
-r, --region <REGION>​
指定地域。​
-e, --endpoint <ENDPOINT>​
自定义 ADrive endpoint。​
-o, --output <FORMAT>​
指定输出格式,支持 json、table、csv、yaml、markdown。​
--query <QUERY>​
使用 JMESPath 过滤输出结果。​
--dry-run​
仅预览操作,不实际执行。​
--describe​
输出结构化命令自描述。​
--language <en|zh>​
设置帮助语言。skill list 和 skill export 也支持该参数。​
-y, --yes​
交互式自动确认。​
--confirm <RESOURCE>​
在非交互场景中使用精确 adrive:// 目标确认删除。​
--no-color [<BOOL>]​
关闭彩色输出,也支持 NO_COLOR=1。​
-v/-q​
启用详细输出或静默输出。​
​
环境变量​
​
变量​
说明​
ADRIVE_ACCESS_KEY​
ADrive access key ID。​
ADRIVE_SECRET_KEY​
ADrive secret access key。​
ADRIVE_SECURITY_TOKEN​
可选 STS token。​
ADRIVE_REGION​
ADrive 地域,未设置 endpoint 时用于推导 https://ids-<region>.volces.com。​
ADRIVE_ENDPOINT​
ADrive IDS endpoint 覆盖。​
​
故障速查​
​
现象​
排查​
鉴权失败(exit 2)​
检查 ADRIVE_ACCESS_KEY 和 ADRIVE_SECRET_KEY,并执行 ve-adrive-cli doctor --check auth 命令。​
请求发到错误主机​
设置 ADRIVE_ENDPOINT,或通过 config set endpoint 指向正确的 IDS 主机。​
名称无法寻址​
追加 --by-name,通过 CLI 将名称解析为 ID。​
删除被拒​
非交互场景需同时指定 --force 和精确的 --confirm <adrive://...>。​
--include-uploads 未清理上传​
  • 该参数仅扫描本 CLI checkpoint 流。​
  • 外部上传不会被扫描。​
​
如需获取完整诊断信息,执行以下命令:​
​
ve-adrive-cli doctor --output json​
​
​
最近更新时间:2026.08.21 16:38:33
这个页面对您有帮助吗?
有用
有用
无用
无用