> ## 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：快速开始

> 安装 KaleidoCLI，完成首次运行设置，并配置默认的 API 与节点端点，几分钟内即可在终端使用比特币分层协议交易

## 环境要求

* Python 3.10 或更高版本
* 推荐使用 [`uv`](https://docs.astral.sh/uv/)，也可以使用 `pip`
* 使用 `node` 命令以及任何本地 RLN 工作流都需要 Docker 与 Docker Compose

## 安装

### 使用 `uv` 全局安装

```bash theme={null}
uv tool install git+https://github.com/kaleidoswap/kaleido-cli.git
```

这种方式无需先克隆仓库即可安装 `kaleido` 可执行文件。

### 从本地代码副本安装

```bash theme={null}
git clone https://github.com/kaleidoswap/kaleido-cli
cd kaleido-cli
make install
```

### 从代码副本引导安装

```bash theme={null}
python install.py
```

## 首次运行设置

新用户请从这条命令开始：

```bash theme={null}
kaleido setup
```

不带参数的 `kaleido setup` 以非交互方式运行：它会立即以默认设置创建并启动一个本地 Docker mutinynet 节点，因此 Docker 必须处于运行状态。比特币网络是可选的位置参数（默认为 `mutinynet`）：

```bash theme={null}
kaleido setup signetcustom
kaleido setup mutinynet --env-name taker-1
```

使用 `--mode` 可以显式选择配置档案：

* `market`：保存用于市场数据和服务端交换流程的 API 设置
* `local`：配置 API 设置，并可选择创建本地 Docker 节点环境

### 非交互示例

```bash theme={null}
# 使用已保存的默认值完成仅市场模式设置
kaleido setup --mode market --defaults

# 使用默认值创建并启动本地节点环境
kaleido setup --mode local --create-node --defaults
```

### 设置标志

| 标志                       | 用途                           |
| ------------------------ | ---------------------------- |
| `<network>` (positional) | 本地节点使用的比特币网络，默认为 `mutinynet` |
| `--mode market\|local`   | 选择设置档案                       |
| `--defaults`             | 使用已保存的值或默认值，不再弹出提示           |
| `--api-url`              | 保存 KaleidoSwap API 基础 URL    |
| `--node-url`             | 直接保存节点 URL                   |
| `--create-node`          | 在设置过程中创建 Docker 节点环境         |
| `--spawn-dir`            | 设置命名环境的基础目录                  |
| `--env-name`             | 为设置过程中创建的环境命名                |
| `--node-count`           | 要创建的节点数量                     |
| `--start`                | 环境创建完成后启动它                   |

## 配置

CLI 将配置存储在：

```text theme={null}
~/.kaleido/config.json
```

支持的键：

* `api-url`
* `node-url`
* `network`
* `spawn-dir`

命令示例：

```bash theme={null}
kaleido config show
kaleido config set api-url https://api.signet.kaleidoswap.com
kaleido config set network signet
kaleido config set spawn-dir ~/.kaleido
kaleido config path
```

## 快速上手

### 仅市场模式

```bash theme={null}
kaleido setup --mode market --defaults
kaleido market pairs
kaleido market quote BTC/USDT --from-amount 0.001
```

### 本地节点

```bash theme={null}
kaleido setup --mode local --create-node --defaults
kaleido node init
kaleido node unlock
kaleido node info
kaleido wallet address
```

## Shell 补全

为当前 shell 安装补全：

```bash theme={null}
kaleido --install-completion
```

或者打印补全脚本以便手动安装：

```bash theme={null}
kaleido --show-completion
```

## 何时覆盖配置

已存储的配置适用于你的默认环境。需要时可以按命令覆盖：

```bash theme={null}
kaleido --api-url https://api.signet.kaleidoswap.com market pairs
kaleido --node-url http://localhost:3002 wallet balance
```

如果你需要管理多套本地 RLN 节点栈，请继续阅读[节点环境](/cn/cli/node-environments)。