CLI 命令选项
基础语法
身份验证
| 命令 | 说明 | 示例 |
|---|---|---|
login | 使用令牌登录，令牌会持久化到本地。 | apifox login --with-token <您的令牌> |
logout | 退出登录。 | apifox logout |
whoami | 显示当前登录的用户信息。 | apifox whoami |
项目管理
| 命令 | 说明 | 示例 |
|---|---|---|
project list | 列出所有项目（ID、名称、描述）。 | apifox project list |
project view | 查看特定项目的详细配置。 | apifox project view <projectId> |
环境管理
| 命令 | 说明 | 示例 |
|---|---|---|
environment list | 列出项目下的所有环境。 | apifox environment list --project <projectId> |
environment view | 查看特定环境的配置详情（前置 URL 等）。 | apifox environment view <envId> --project <projectId> |
自动化测试
| 命令 | 说明 | 示例 |
|---|---|---|
test-scenario list | 列出项目的所有场景用例。 | apifox test-scenario list --project <projectId> |
test-scenario run | 运行指定的场景用例。 | apifox test-scenario run <id> --project <pid> |
test-suite list | 列出项目的所有测试套件。 | apifox test-suite list --project <projectId> |
test-suite run | 运行指定的测试套件。 | apifox test-suite run <id> --project <pid> |
核心运行命令：apifox run
常用命令示例 (从客户端复制)
-t: 场景用例 ID-e: 运行环境 ID-r: 报告格式--upload-report: 执行完后自动同步报告到云端运行参数表说明
| 参数 | 描述 | 默认值 |
|---|---|---|
--access-token <token> | 设置鉴权令牌 | - |
-t, --test-scenario <id> | 指定场景用例 ID | - |
-f, --test-scenario-folder <id> | 指定场景用例目录 ID | - |
--test-suite <id> | 指定测试套件 ID | - |
--project <id> | 项目 ID | - |
-e, --environment <id> | 环境 ID | - |
-r, --reporters [reporters] | 指定报告类型 (cli, html, json, junit) | ["cli"] |
--out-dir <path> | 输出报告目录 | ./apifox-reports |
--out-file <name> | 输出报告文件名（不含后缀）。支持变量: {SCENARIO_NAME}, {FOLDER_NAME}, {GENERATE_TIME} | apifox-report-{timestamp} |
--out-json-failures-separated | 开启 JSON 报告时，将失败详情单独导出 | - |
-n, --iteration-count <n> | 设置循环次数 | - |
-d, --iteration-data <path> | 设置循环数据 (JSON/CSV) 或数据 ID | - |
--on-error <behavior> | 设置错误处理方式 (ignore, continue, end) | - |
--global-var <key=value> | 设置全局变量。支持设置多个。 | - |
--env-var <key=value> | 设置环境变量。支持设置多个。 | - |
--variables <path> | 指定包含变量的本地文件路径 | - |
--notification <ids> | 运行完成后通知指定对象 ID (逗号分隔) | - |
--notification-failed-event <ids> | 仅失败时通知指定对象 ID | - |
--external-program-path <path> | 指定外部脚本/程序的所处目录 | 当前目录 |
--database-connection <path> | 指定数据库配置文件的所处路径 | - |
--ignore-redirects | 阻止自动重定向 | - |
--silent | 开启静默模式，不输出至控制台 | - |
--color <on|off|auto> | 控制台彩色输出开关 | auto |
--delay-request [ms] | 请求之间的停顿间隔 | 0 |
--timeout-request [ms] | 接口请求超时时间 | 0 |
--timeout-script [ms] | 脚本执行超时时间 | 0 |
-k, --insecure | 关闭 SSL 校验 | - |
--ssl-client-cert-list <path> | 指定客户端证书配置路径 (JSON) | - |
--upload-report | 将本次测试报告上传至云端查看 | - |
-b, --bigint | 兼容 BigInt 类型 | false |
--verbose | 显示详细的请求/响应信息 | - |
--lang <zh |en> | 设置 CLI 语言 | zh |
CLI 中的文件上传
先将需要的文件复制或上传到运行 CLI 的机器上。
把该文件路径复制下来。 例如：
/var/www/myapp/uploads/apifox-xiangmu.jpg然后在 Apifox 的自动化测试里定位到需要上传文件的接口，点击 “批量编辑” 按钮。
将上传到 CLI 机器上的 “文件路径” 填入到格式中 “参数值” 的位置即可。
除此之外，还可以把文件路径放到环境变量的 “远程值” 那里，然后在 “批量编辑” 中通过变量的方式引用。
CLI 中的数据库操作
对于包含数据库操作的场景用例，在命令行生成界面点击 “下载数据库配置文件”。
下载该文件（如
database-connections.json），并放在运行 CLI 的目录下。在命令中包含
--database-connection 选项。示例：将本地 CLI 测试报告上传到云端
--upload-report 参数：在命令执行时加入参数：
查看上传的报告：打开 Apifox 自动化测试面板中的 “测试报告” 找到 “共享” 栏目 
CLI 中使用外部脚本/程序
--external-program-path 引用外部脚本：./scripts 目录下的程序。如果没有指定层级，默认是当前 CLI 执行目录。1.
2.
SSL
使用单个 SSL 客户端证书
--ssl-client-cert--ssl-client-key--ssl-client-passphrase使用 SSL 客户端证书配置文件（支持多个证书）
--ssl-client-cert-listssl-client-cert-list.jsonssl-client-cert-list.json
[
{
"name": "domain1",
"matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
"key": {"src": "./client.domain1.key"},
"cert": {"src": "./client.domain1.crt"},
"passphrase": "changeme"
},
{
"name": "domain2",
"matches": ["https://domain2.com/*"],
"key": {"src": "./client.domain2.key"},
"cert": {"src": "./client.domain2.crt"},
"passphrase": "changeme"
}
]--ssl-client-cert、--ssl-client-key 和 --ssl-client-passphrase 选项。如果 URL 在列表中没有匹配项，会使用这些选项作为后备选项。HTTP/2
--preferred-http-version 参数配置使用特定的协议版本发送请求。1.
"HTTP/2" - HTTP/2 应用层协议协商（ALPN），仅支持 HTTPS 请求2.
"HTTP/2-with-prior-knowledge" - 已知的 HTTP/23.
"HTTP/1" - HTTP/1.11.
--preferred-http-version="https=HTTP/2,http=HTTP/2-with-prior-knowledge"2.
--preferred-http-version="HTTP/1"3.
--preferred-http-version="HTTP/2"