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

# CLI 命令行工具

> 以 JSON 原生格式访问 QFEX 行情、交易和账户状态的命令行工具

[QFEX CLI](https://github.com/QFEX-org/cli) 为人工操作员和 AI 智能体提供仅返回 JSON 的 QFEX 命令行接口。

后台守护进程管理底层 QFEX WebSocket 连接；从调用方角度看，CLI 命令保持无状态。

使用 CLI 配合 AI 智能体的概览指南见[智能体交易](https://docs.qfex.com/cn/qfex/agentic-trading.md)。

## 安装

```sh theme={null}
brew install QFEX-org/tap/qfex
```

## 快速开始

```sh theme={null}
# Start the background daemon
qfex daemon start

# Query market data (no credentials required)
qfex market bbo AAPL-USD

# Log in to trade or access account data
qfex login
qfex daemon restart

# Place an order
qfex order place --symbol AAPL-USD --side BUY --type LIMIT --tif GTC --qty 1 --price 200

# Stop the daemon when finished
qfex daemon stop
```

## 为什么使用 CLI

* 所有命令均输出 JSON，方便通过管道传给 `jq` 或在代码中解析。
* 守护进程与行情和交易 WebSocket 保持持久连接，因此脚本无需直接管理订阅、认证或连接生命周期。
* 行情命令无需凭据。
* 交易命令使用 [API 密钥](https://docs.qfex.com/cn/api-reference/api-keys.md)页面介绍的密钥。

## 常用命令

```sh theme={null}
# Market data
qfex market bbo AAPL-USD
qfex market orderbook AAPL-USD --depth 5
qfex market trades AAPL-USD --limit 50

# Orders
qfex order place --symbol AAPL-USD --side BUY --type MARKET --tif IOC --qty 1
qfex order list
qfex order cancel --symbol AAPL-USD --order-id <order-id>

# Positions and account state
qfex position list
qfex account balance
qfex account leverage get

# Live streams
qfex watch bbo AAPL-USD
qfex watch orders
qfex watch fills
```

## 环境

CLI 支持 QFEX 生产和 UAT 环境：

* `prod`：连接 `qfex.com`，使用真实资金。
* `uat`：连接 `qfex.io`，无需真实资金即可测试策略和集成。

可在 `qfex login` 时选择环境，也可修改 `~/.config/qfex/config.yaml` 后重启守护进程。

## 子账户

如果您有子账户，`qfex login` 会要求选择默认使用的账户。选择结果以 `selected_subaccount` 保存到 `~/.config/qfex/config.yaml`。

之后可用以下命令查看或修改：

```sh theme={null}
qfex account subaccounts current
qfex account subaccounts select <account-id>
qfex account subaccounts list
```

选择另一个子账户会更新配置并重启守护进程，使已认证的交易及账户请求使用**新的账户**上下文。

也可在子账户间转账：

```sh theme={null}
qfex account subaccounts transfer
```

该命令接受 `--from`、`--to` 和 `--amount`（美元金额）。可将 `--from` 或 `--to` 之一设为 `"primary"`，表示主账户；另一方应为 `qfex account subaccounts list` 返回的账户 UUID。

## 相关链接

* [智能体交易](https://docs.qfex.com/cn/qfex/agentic-trading.md)
* [QFEX CLI 代码仓库](https://github.com/QFEX-org/cli)
* [API 密钥设置说明](https://docs.qfex.com/cn/api-reference/api-keys.md)
* [WebSocket 概览](https://docs.qfex.com/cn/websocket/main.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.