# @x-money/cli 中文文档

规范地址：https://npmcn.com/package/%40x-money/cli/

版本：0\.2\.0
npm 元数据更新时间：2026-11-02T22:13:48.155Z
中文译文更新时间：2026-11-02T22:37:24.451Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40x-money/cli
原文对照：https://npmcn.com/package/%40x-money/cli/?lang=original
项目主页：https://xmoney.mintlify.site/docs

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：67.6 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：1 个
- 首次发布：2026-10-02T22:07:10.454Z
- 最新版本发布：2026-10-29T19:33:40.311Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

xmoney，命令行中的X Money API

## 安装

```sh
npm install @x-money/cli
```

也可以使用：`pnpm add @x-money/cli`、`yarn add @x-money/cli`、`bun add @x-money/cli`

## README

# @x-money / cli

`xmoney`，从终端获取X Money API。创建结帐会话、对关联帐户收费、发放退款和付款，以及读取API公开的任何内容。

每个命令都是一个薄薄的包装 [@x-money /核心](https://www.npmjs.com/package/@x-money/core)因此，两者不能在API提供的功能上产生分歧。

Node 24或更新版本。

```bash
npm install -g @x-money/cli
xmoney --help
```

或者不安装就运行它： `npx @x-money/cli --help`.

## 快速启动

```bash
xmoney login                      # prompts for a key, stores it on the default profile
xmoney whoami                     # shows which key and base url resolved, key masked
xmoney payments list --limit 10
```

## 凭证

键按顺序在三个地方查找： `--api-key`,然后 `XMONEY_API_KEY`，然后是磁盘上的配置文件。基url的解析方式相同 `--base-url` 和 `XMONEY_API_BASE_URL`，返回到配置文件，然后返回到SDK默认值。

配置文件将键分开，例如，测试模式键放在活动键旁边。 `--profile` 或者 `XMONEY_PROFILE` 选择一个，并命名默认值 `default`.

```bash
xmoney login --profile test       # prompts for your xmsk_test_ key
xmoney payments list --profile test
```

配置文件位于 `$XDG_CONFIG_HOME/xmoney/config.json`，或者 `~/.config/xmoney/config.json` 当它未设置时。它保存密钥，所以它是写的 `0600` 在一个 `0700` 目录，并将现有文件收紧到 `0600` 每次写。

## 命令

| 资源 | 行动 |
| --- | --- |
| `checkouts` | `create`， `get` |
| `exchanges` | `create`， `get` |
| `accounts` | `get`， `list`， `revoke` |
| `customers` | `get`， `list` |
| `payments` | `create`， `get`， `list`， `capture`， `release-authorization`， `update-authorization` |
| `refunds` | `create`， `get`， `list` |
| `payouts` | `create`， `get`， `list`， `reverse` |
| `settlements` | `list`， `get`， `file` |

\+ `login` 和 `whoami`. `xmoney --help` 打印完整的标志引用，和 `--help` 适用于任何命令。

根据方法检查该表 `@x-money/core` 在两个方向上都是公开的，所以如果在同一个发行版中没有命令发布，资源就无法到达SDK。

## 创造新事物

每一个 `create` 接受输入的标志，列在下面 `xmoney --help`。任何他们没有覆盖的都可以通过 `--data` 作为原始JSON，和 `--metadata k=v` 重复。

```bash
xmoney refunds create --payment <payment-id> --amount 500 --reference refund-order-8471
xmoney payouts create --data '{"account_id":"xmac_...","amount":2500}'
```

金额是以货币最小单位表示的整数，所以 `49999` 是499.99美元。

每个POST都携带一个生成的等幂键。通过 `--idempotency-key` 使跨调用的重试安全，当命令由订单id驱动时，这是您想要的。

有了测试钥匙， `--test-outcome` 发送 `Xm-Test-Outcome` 头，例如强制拒绝、过期或授权错误 `--test-outcome INSUFFICIENT_FUNDS`.

## 分页

列表返回一个页面。 `--all` 跟随游标到末尾并返回累积集，因此它是每个页面的请求，对于大型帐户来说值得考虑。

```bash
xmoney payouts list --limit 100 --all
```

## 输出和退出代码

结果是标准输出上的JSON，没有别的，所以 `| jq` 作品。其他所有内容，包括提示和错误，都将进入stderr。

`--verbose` 为每个请求添加一个标准错误行，包含其方法、路径、状态和 `x-request-id`，因此，一个调用成功了，但返回了一些令人惊讶的结果，仍然会留下一个id来引用。

| 退出 | 意义 |
| --- | --- |
| `0` | 成功。 |
| `1` | API返回了一个错误。错误对象，带有其 `code`， `status`, `request_id`，将被打印为JSON。 |
| `2` | 请求没有得到响应：网络故障、超时或中止。 |
| `64` | 命令行或凭证错误：缺少标志，或密钥不是密钥。什么也没发。 |

SDK可以引发的每个错误都映射到其中一个。堆栈跟踪意味着CLI本身存在错误。

## 文档

指南、API参考和webhook目录在 [xmoney.mintlify.site /文档](https://xmoney.mintlify.site/docs).

## 支持

报告错误并提出问题 [X帮助中心](https://help.x.com/en/forms)。安全问题也是如此；请不要公开发布。

## 许可证

麻省理工学院。全文在包中作为 `LICENSE`.

## 常见问题

### @x-money/cli 是什么？

xmoney，命令行中的X Money API

### 如何安装 @x-money/cli？

在项目目录运行 npm install @x-money/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 xmoney，可以用 npx xmoney 直接运行。

### @x-money/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/x-money\_\_cli 是否存在。

### @x-money/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @x-money/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @x-money/cli 可以商用吗？

@x-money/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @x-money/cli 还在维护吗？

最新版本 0\.2\.0 发布于 2026/10/30（4 天前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/10/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。