> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kaleidoswap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 命令参考

> KaleidoCLI 的完整命令地图，包含嵌套命令组和最重要的标志，涵盖节点、钱包、资产、通道、市场与交换操作

## 根命令

```bash theme={null}
kaleido [global options] <command> [subcommand] [args]
```

### 全局选项

| 选项                     | 含义             |
| ---------------------- | -------------- |
| `--json`               | 输出原始 JSON      |
| `--agent`              | 关闭提示，适用于非交互式场景 |
| `--node-url`           | 覆盖已配置的节点 URL   |
| `--api-url`            | 覆盖已配置的 API URL |
| `--install-completion` | 安装 shell 补全    |
| `--show-completion`    | 打印 shell 补全内容  |

## 顶层命令

| 命令        | 说明                          |
| --------- | --------------------------- |
| `setup`   | 首次运行配置，并可选择创建本地节点           |
| `node`    | 基于 Docker 的 RLN 环境生命周期与钱包访问 |
| `wallet`  | BTC 钱包操作                    |
| `asset`   | RGB 资产管理与发行                 |
| `channel` | 通道管理与 LSP 订单流程              |
| `peer`    | 对等节点连通性                     |
| `payment` | 闪电与 RGB+LN 支付               |
| `market`  | 市场发现、报价和路由                  |
| `swap`    | 由做市商支撑的原子交换流程               |
| `config`  | 已存储的 CLI 配置                 |

## `setup`

| 命令                                                    | 备注                                     |
| ----------------------------------------------------- | -------------------------------------- |
| `kaleido setup`                                       | 非交互式默认行为：以默认设置创建并启动一个本地 mutinynet 节点   |
| `kaleido setup signetcustom`                          | 在显式指定的网络上执行同样的流程（位置参数，默认为 `mutinynet`） |
| `kaleido setup mutinynet --env-name taker-1`          | 自定义环境名称                                |
| `kaleido setup --mode market --defaults`              | 仅市场模式设置                                |
| `kaleido setup --mode local --create-node --defaults` | 本地节点设置                                 |

主要标志：`--mode`、`--defaults`、`--api-url`、`--node-url`、`--create-node`、`--spawn-dir`、`--env-name`、`--node-count`、`--start`

## `node`

| 命令                                   | 说明                              |
| ------------------------------------ | ------------------------------- |
| `kaleido node create [name]`         | 创建命名环境                          |
| `kaleido node list`                  | 列出环境及节点 URL                     |
| `kaleido node use <name> [--node N]` | 选择当前活动节点                        |
| `kaleido node up <name>`             | 启动容器                            |
| `kaleido node stop <name>`           | 停止容器                            |
| `kaleido node down <name>`           | 移除容器和网络                         |
| `kaleido node ps <name>`             | 显示容器状态                          |
| `kaleido node logs <name>`           | 实时输出日志（`--no-follow` 打印已有日志后退出） |
| `kaleido node clean <name>`          | 删除数据卷（`--yes` 跳过确认提示）           |
| `kaleido node info`                  | 显示节点详情                          |
| `kaleido node network`               | 显示网络信息                          |
| `kaleido node init`                  | 初始化钱包                           |
| `kaleido node unlock`                | 解锁钱包                            |
| `kaleido node lock`                  | 锁定钱包                            |
| `kaleido node shutdown`              | 优雅关闭节点                          |

### `node swap`

| 命令                                                        | 说明                                                                               |
| --------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `kaleido node swap pubkey`                                | 打印接单方公钥                                                                          |
| `kaleido node swap init`                                  | 启动本地的做市方初始化交换流程（`--from-asset`、`--qty-from`、`--to-asset`、`--qty-to`、`--timeout`） |
| `kaleido node swap whitelist --swapstring '<swapstring>'` | 在接单方一侧将某个交换加入白名单                                                                 |
| `kaleido node swap execute`                               | 执行本地节点交换                                                                         |
| `kaleido node swap status <payment-hash>`                 | 查询本地节点交换状态（`--taker` 或 `--maker`）                                                |
| `kaleido node swap list`                                  | 列出节点已知的交换                                                                        |

## `wallet`

| 命令                                       | 说明                                                     |
| ---------------------------------------- | ------------------------------------------------------ |
| `kaleido wallet address`                 | 新的 BTC 存入地址                                            |
| `kaleido wallet balance`                 | BTC 余额                                                 |
| `kaleido wallet send <amount> <address>` | 发送 BTC                                                 |
| `kaleido wallet utxos`                   | 列出 UTXO                                                |
| `kaleido wallet create-utxos`            | 创建供 RGB 使用的 UTXO（`--up-to`、`--fee-rate`、`--skip-sync`） |
| `kaleido wallet transactions`            | 交易历史                                                   |
| `kaleido wallet backup <path>`           | 备份钱包数据                                                 |
| `kaleido wallet restore <path>`          | 恢复钱包数据                                                 |
| `kaleido wallet change-password`         | 修改钱包密码                                                 |
| `kaleido wallet estimate-fee`            | 估算费率（`--blocks/-b`，默认 6）                               |

## `asset`

| 命令                                                 | 说明           |
| -------------------------------------------------- | ------------ |
| `kaleido asset list`                               | 列出资产         |
| `kaleido asset balance <asset-id>`                 | 资产余额         |
| `kaleido asset metadata <asset-id>`                | 资产元数据        |
| `kaleido asset invoice <asset-id>`                 | 创建 RGB 发票    |
| `kaleido asset send <asset-id> <amount> <invoice>` | 发送 RGB 资产    |
| `kaleido asset send-batch`                         | 向多个接收方发送     |
| `kaleido asset transfers <asset-id>`               | 转账历史         |
| `kaleido asset refresh`                            | 刷新待处理的转账     |
| `kaleido asset sync`                               | 同步 RGB 钱包    |
| `kaleido asset fail-transfers`                     | 将待处理的转账标记为失败 |
| `kaleido asset media`                              | 获取资产媒体       |

### `asset issue`

| 命令                        | 说明            |
| ------------------------- | ------------- |
| `kaleido asset issue nia` | 发行固定供应量的同质化资产 |
| `kaleido asset issue cfa` | 发行可收藏的同质化资产   |
| `kaleido asset issue uda` | 发行独一无二的数字资产   |

所有 `issue` 子命令都接受 `--precision`，用于指定小数位数。

## `channel`

| 命令                                   | 说明                         |
| ------------------------------------ | -------------------------- |
| `kaleido channel list`               | 列出通道                       |
| `kaleido channel open <peer>`        | 开通通道                       |
| `kaleido channel close <channel-id>` | 关闭通道（需要 `--peer <pubkey>`） |

### `channel order`

| 命令                                             | 说明                                                                                      |
| ---------------------------------------------- | --------------------------------------------------------------------------------------- |
| `kaleido channel order create [client-pubkey]` | 创建 LSP 通道订单（公钥默认为本地节点；`--yes` 直接接受获取到的询价价格）                                             |
| `kaleido channel order get <order-id>`         | 获取订单状态（`--access-token`）                                                                |
| `kaleido channel order pay <order-id>`         | 支付通道订单（`--access-token`；非交互式使用时传入 `--onchain` 或 `--offchain`，以及 `--fee-rate` 和 `--yes`） |
| `kaleido channel order decide <order-id>`      | 提交费率决定（`--accept` 或 `--reject`、`--access-token`）                                        |
| `kaleido channel order estimate-fees`          | 估算通道订单费用                                                                                |

### `channel lsp`

| 命令                                 | 说明         |
| ---------------------------------- | ---------- |
| `kaleido channel lsp info`         | LSP 元数据与选项 |
| `kaleido channel lsp network-info` | LSP 网络信息   |

## `peer`

| 命令                                 | 说明         |
| ---------------------------------- | ---------- |
| `kaleido peer list`                | 列出对等节点     |
| `kaleido peer connect <peer>`      | 连接到对等节点    |
| `kaleido peer disconnect <pubkey>` | 断开与对等节点的连接 |

## `payment`

| 命令                                                 | 说明                                                  |
| -------------------------------------------------- | --------------------------------------------------- |
| `kaleido payment invoice`                          | 创建 BOLT11 或 RGB+LN 发票（`--expiry`，默认 3600）           |
| `kaleido payment send <invoice>`                   | 支付发票                                                |
| `kaleido payment list`                             | 列出支付记录                                              |
| `kaleido payment status <payment-hash>`            | 支付状态                                                |
| `kaleido payment decode <invoice>`                 | 解码发票                                                |
| `kaleido payment invoice-status <invoice>`         | 发票状态                                                |
| `kaleido payment keysend <dest-pubkey> <amt-msat>` | 无需发票的即时闪电支付（RGB 场景使用 `--asset-id`/`--asset-amount`） |

## `market`

| 命令                             | 说明      |
| ------------------------------ | ------- |
| `kaleido market assets`        | 列出资产    |
| `kaleido market pairs`         | 列出交易对   |
| `kaleido market quote <pair>`  | 请求报价    |
| `kaleido market info`          | 做市商节点信息 |
| `kaleido market routes <pair>` | 可用路由    |

## `swap`

### `swap atomic`

| 命令                                          | 说明                                                                                               |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `kaleido swap atomic init <pair>`           | 初始化原子交换                                                                                          |
| `kaleido swap atomic execute`               | 执行交换（`--swapstring`、`--taker-pubkey`、`--payment-hash`，省略时会提示输入；`--auto-whitelist` 会先在本地节点上加入白名单） |
| `kaleido swap atomic status <payment-hash>` | 原子交换状态                                                                                           |
| `kaleido swap atomic run <pair>`            | 运行完整的原子交换流程                                                                                      |

## `config`

| 命令                                 | 说明        |
| ---------------------------------- | --------- |
| `kaleido config show`              | 打印当前配置    |
| `kaleido config set <key> <value>` | 更新单个配置键   |
| `kaleido config reset`             | 将配置重置为默认值 |
| `kaleido config path`              | 打印配置文件路径  |

有效的配置键：`node-url`、`api-url`、`network`、`spawn-dir`

## 机器可读模式

每个命令组都可以与 `--json` 组合使用：

```bash theme={null}
kaleido --json wallet balance
kaleido --json market quote BTC/USDT --from-amount 0.001
```