Antom, leading provider of tailored payment solutionsAntom, leading provider of tailored payment solutions

Antom CLI 使用指南

Antom CLI 是 Antom 提供的命令行工具，帮助商户开发者通过终端完成登录授权、商户 profile 管理、报表查询和支付集成诊断等操作。

功能特性

  • 浏览器授权登录：支持通过默认浏览器登录，以及适合 Agent/CI 的非交互式登录。
  • 多 profile 管理：支持在同一台机器上保存多个商户 profile，并切换当前 active profile。
  • Test/Live 环境切换：默认使用 test 环境，通过 --live 使用 live 环境。
  • 报表查询：支持查询指定日期或日期范围内的账单文件下载地址，以及查询单笔交易明细。
  • 集成诊断：支持根据支付请求中的 paymentRequestId 诊断报错支付请求的原因。
  • 双输出模式：默认以便于阅读的文本格式输出，也支持 --json 输出结构化 JSON。

前置准备

在使用 Antom CLI 前，请确认你已经具备以下条件：

安装

目前 Antom CLI 安装脚本仅支持 macOS 系统。

通过脚本安装 推荐

在终端执行以下命令：

copy
curl -fsSL https://mdn.alipayobjects.com/portal_4vwbay/uri/file/as/release/antom-cli-install.sh | bash

安装完成后，执行以下命令验证安装：

copy
antom version
antom --help

如果能够正常输出版本号或帮助信息，说明安装成功。如果终端提示 antom 命令不存在，请执行以下命令确认安装目录已经加入 PATH。

copy
export PATH="$HOME/.local/bin:$PATH"

快速开始

步骤 1：登录授权

Antom CLI 提供了多种登录方式，适用于不同场景：

推荐使用默认浏览器登录，适用于本地开发环境。执行命令后，CLI 会打开默认浏览器，引导你完成 Antom 授权。

copy
antom login

步骤 2：查看当前身份

使用以下命令查看当前商户身份和登录环境：

copy
antom whoami

步骤 3：查询报表下载地址

Antom CLI 支持查询指定日期范围内的账单文件下载地址。查询到的链接可直接用于下载对账文件。

copy
# 查询指定日期的账单
antom report download-list --date 20260601 --bill-type SETTLEMENT_DETAIL

# 查询日期范围内的账单
antom report download-list --date 20260601-20260630 --bill-type SETTLEMENT_DETAIL

步骤 4：诊断报错支付请求

当支付请求出现错误时，可通过以下命令快速诊断问题原因，适用于开发和调试阶段。

copy
antom integration diagnose --request-id PAY_202606151234

命令参考

全局参数

以下参数适用于所有 Antom CLI 命令，用于控制工具的通用行为和环境设置：

参数

说明

--profile <name>

指定本次命令使用的 profile。未传时使用 active profile。

--live

使用 live 环境。默认使用 test 环境。

--json

输出可被程序解析的 JSON。

--debug

输出诊断日志到 stderr。也可通过 ANTOM_DEBUG=1 启用。

--color <auto|on|off>

控制颜色输出。默认值为 auto。

--help

查看命令帮助。

登录相关命令

login（登录授权）

用于完成 Antom CLI 的登录授权。命令格式如下：

copy
antom login [flags]

包含以下参数：

参数

说明

--non-interactive

发起非交互式浏览器授权，输出授权信息后退出。

--complete

完成由 --non-interactive 发起的待处理授权。

--interactive

使用手动凭据登录。

登录流程如下：

  1. CLI 发起浏览器授权或读取用户输入的手动凭据。
  2. 用户在浏览器中完成授权，或输入 client ID 和商户 RSA 私钥。
  3. CLI 校验授权或凭据。
  4. 授权成功后，CLI 将 profile 和凭据保存到本地。
  5. 新登录的 profile 会成为 active profile。

logout（登出）

用于删除本地 profile 并清理本地凭据。

copy
antom logout
antom logout --all

注意：

  • 不传 --all 时，删除当前 active profile。
  • 传入 --all 时，删除所有本地 profiles。

whoami（当前身份）

用于显示当前本地 Antom CLI 身份。

copy
antom whoami
antom whoami --json

login list（Profile 列表）

用于列出本地所有 profiles。

copy
antom login list
antom login list --json

login switch（切换 Profile）

用于切换 active profile。后续未显式指定 --profile 的命令会使用该 profile。

copy
antom login switch my-merchant

报表相关命令

report download-list（报表下载地址）

用于查询指定日期或日期范围内可下载的账单文件 URL。需要通过 --bill-type 指定账单类型。

copy
antom report download-list --date 20260601 --bill-type SETTLEMENT_DETAIL
antom report download-list --date 20260601-20260630 --bill-type SETTLEMENT_DETAIL
antom report download-list --date 20260601 --bill-type SETTLEMENT_SUMMARY --json

包含以下参数：

参数

说明

--date/-d

账单日期，格式为 YYYYMMDD 或 YYYYMMDD-YYYYMMDD。

--bill-type

账单类型，例如 SETTLEMENT_DETAIL、SETTLEMENT_SUMMARY、TRANSACTION_DETAIL。

--all

在面向用户的输出中展示完整结果。

report transaction-detail（交易明细）

用于查询单笔 Antom 交易明细。

copy
antom report transaction-detail --transaction-id 20260518993030096600502796446525944
antom report transaction-detail -t 20260518993030096600502796446525944 --json

包含以下参数：

参数

说明

--transaction-id / -t

要查询的交易 ID。

集成相关命令

integration diagnose（集成诊断）

诊断报错支付请求的原因。入参为支付请求中的 paymentRequestId，通过 --request-id 传入。

copy
antom integration diagnose --request-id PAY_202606151234
antom integration diagnose --live --request-id PAY_202606151234
antom integration diagnose --request-id PAY_202606151234 --json

包含以下参数：

参数

说明

--request-id

支付请求中的 paymentRequestId。

其他命令

open（打开 Antom Dashboard）

快速在默认浏览器中打开 Antom 商户控制面板，便于在线查看业务数据和管理配置。

copy
antom open

version（版本信息）

用于查看当前安装的 Antom CLI 版本信息，便于排查兼容性问题或确认工具更新情况。

copy
antom version
antom version --json

故障排查

Antom CLI 常用的排查方式，包括通过环境变量调整 CLI 行为、查看命令帮助，以及启用调试日志定位问题。

环境变量

以下环境变量可用于控制 Antom CLI 的默认 profile、调试日志和颜色输出。

变量名

说明

ANTOM_PROFILE

指定默认 profile 名。

ANTOM_DEBUG

启用 debug 日志。

NO_COLOR

禁用颜色输出。

FORCE_COLOR

强制启用颜色输出。

查看命令帮助

如果不确定某个命令的用法、参数含义或支持的选项，可以使用 --help 查看帮助信息。

copy
antom --help
antom login --help
antom report download-list --help
antom integration diagnose --help

启用调试模式

当需要排查命令执行异常或查看更详细的诊断信息时，可以通过 --debug 参数启用调试模式。

copy
antom report download-list --date 20260601 --bill-type SETTLEMENT_DETAIL --debug

也可以通过设置 ANTOM_DEBUG=1 环境变量启用调试日志：

copy
ANTOM_DEBUG=1 antom whoami

常见问题

安装后提示 antom 命令不存在，怎么办？

请确认 Antom CLI 的安装目录已经加入 PATH。

copy
export PATH="$HOME/.local/bin:$PATH"
antom version

执行非交互式登录后，为什么还没有完成授权？

非交互式登录需要先发起授权，再完成授权。

copy
# 第一步：发起非交互式授权
antom login --non-interactive

# 第二步：完成待处理授权
antom login --complete

提示 profile 不存在，怎么办？

请先查看本地已经保存的商户 profile 列表，再切换到已有的 profile。

copy
# 查看本地 profile
antom login list

# 切换到已有 profile
antom login switch my-merchant

如何让命令输出 JSON，方便脚本分析？

支持结构化输出的命令可以使用 --json，便于脚本解析。

copy
antom whoami --json
antom report download-list --date 20260601 --bill-type SETTLEMENT_DETAIL --json
antom integration diagnose --request-id PAY_202606151234 --json