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

# CLI 命令参考

> chainstream CLI 的完整命令、参数和输出格式列表。

`chainstream` CLI 在一个二进制里暴露了所有数据产品、GraphQL cube 和 DeFi 原语。本页是权威命令参考——叙述式用法与安装指引请参考 [接入方式 → CLI](/cn/docs/access-methods/cli)。

## 安装

```bash theme={null}
# 全局安装（推荐用于交互式使用）
npm install -g @chainstream-io/cli

# 零安装、永远最新（推荐用于 Agent 与 CI）
npx @chainstream-io/cli <command>
```

下面任意一种调用方式都通用。本参考中使用短形式 `chainstream <cmd>`，等价于 `npx @chainstream-io/cli <cmd>`。

## 全局参数

| 参数          | 用途                            |
| ----------- | ----------------------------- |
| `--version` | 打印 CLI 版本并退出                  |
| `--json`    | 输出单行机器可读 JSON（默认输出是美化过的 JSON） |
| `--help`    | 打印当前命令或命令组的帮助                 |

## 环境变量

| 变量                        | 用途                         | 默认值                                      |
| ------------------------- | -------------------------- | ---------------------------------------- |
| `CHAINSTREAM_API_KEY`     | 替代 `config.json` 的 API key | 未设置                                      |
| `CHAINSTREAM_API_URL`     | 覆盖 REST base URL           | `https://api.chainstream.io`             |
| `CHAINSTREAM_AUTH_URL`    | 覆盖 Auth 服务 URL             | 生产默认值                                    |
| `CHAINSTREAM_GRAPHQL_URL` | 覆盖 GraphQL 端点              | `https://graphql.chainstream.io/graphql` |
| `SOLANA_RPC_URL`          | 覆盖 Solana RPC（钱包 / 余额读取用）  | 公共 RPC                                   |
| `BASE_RPC_URL`            | 覆盖 Base RPC                | 公共 RPC                                   |

配置持久化到 `~/.config/chainstream/config.json`；P-256 钱包私钥放在 `~/.config/chainstream/keys/`。`chainstream logout` 清除钱包配置，但保留密钥文件。

## 认证命令（顶层）

这些命令注册在程序根部，没有子命令组。

| 命令                  | 用途                                                                | 参数 / 选项                       |
| ------------------- | ----------------------------------------------------------------- | ----------------------------- |
| `login`             | 创建 TEE 托管钱包（默认），或发起邮箱 OTP 流程。首次登录自动赠送 **nano trial**（50K CU、30 天） | `[email]`；`--key`；`--email`   |
| `verify`            | 完成由 `login --email` 发起的邮箱 OTP 登录                                  | `--otp-id`；`--code`；`--email` |
| `logout`            | 清除会话（保留磁盘上的密钥）                                                    | —                             |
| `bind-email`        | 把邮箱绑定到现有钱包                                                        | `[email]`                     |
| `bind-email-verify` | 完成绑定邮箱的 OTP 流程（非交互式）                                              | `--otp-id`；`--code`；`--email` |

## `token` — 代币信息与分析

| 子命令        | 用途                                               | 选项                                                             |
| ---------- | ------------------------------------------------ | -------------------------------------------------------------- |
| `search`   | 按关键字搜索代币                                         | `--keyword`（必填）；`--chain`（必填）；`--limit`                        |
| `info`     | 获取代币完整详情                                         | `--chain`；`--address`                                          |
| `security` | 安全报告（honeypot、mint authority、freeze authority 等） | `--chain`；`--address`                                          |
| `holders`  | 代币 Top 持有者                                       | `--chain`；`--address`；`--limit`                                |
| `candles`  | OHLCV K 线                                        | `--chain`；`--address`；`--resolution`；`--from`；`--to`；`--limit` |
| `pools`    | 代币的流动性池                                          | `--chain`；`--address`                                          |

## `market` — 市场数据与发现

| 子命令        | 用途            | 选项                               |
| ---------- | ------------- | -------------------------------- |
| `trending` | 按窗口的热门 / 趋势代币 | `--chain`；`--duration`；`--limit` |
| `new`      | 新发代币          | `--chain`；`--limit`              |
| `trades`   | 最近成交，可按代币过滤   | `--chain`；`--token`；`--limit`    |

## `wallet` — 钱包分析、管理与签名

| 子命令        | 用途                     | 选项                              |
| ---------- | ---------------------- | ------------------------------- |
| `sign`     | 用宿主钱包对序列化交易签名          | `--chain`；`--tx`                |
| `profile`  | PnL + 净值 + 持仓 Top 一次取回 | `--chain`；`--address`           |
| `pnl`      | PnL 明细                 | `--chain`；`--address`           |
| `holdings` | 代币余额                   | `--chain`；`--address`；`--limit` |
| `activity` | 转账历史                   | `--chain`；`--address`；`--limit` |
| `address`  | 显示当前钱包地址               | —                               |
| `balance`  | 原生币 + USDC 余额（一次请求）    | `--chain`（`sol` \| `base`）      |
| `set-raw`  | 导入原始私钥（仅供开发 / 测试）      | `--chain`（`base` \| `sol`）      |
| `link`     | 把钱包地址关联到订阅             | `--chain`（`evm` \| `solana`）    |
| `pricing`  | 列出可用的 x402 套餐与价格       | —                               |

## `dex` — DEX 路由、兑换与发币

所有命令都返回 **未签名** 的交易（由服务端构建）；签名在宿主钱包上完成。

| 子命令      | 用途                   | 选项                                                                                                                                                                                          |
| -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `route`  | 聚合路由 + 未签名 swap 交易   | `--chain`；`--from`；`--input-token`；`--output-token`；`--amount`；`--slippage`；`--dex`；`--recipient`；`--anti-mev`；`--gas-price`；`--gas-limit`；`--max-fee-per-gas`；`--max-priority-fee-per-gas` |
| `swap`   | 未签名 swap 交易（直连、不走聚合） | `--chain`；`--from`；`--input-token`；`--output-token`；`--amount`；`--slippage`；`--dex`                                                                                                         |
| `create` | 未签名的 launchpad 发币交易  | `--chain`；`--from`；`--name`；`--symbol`；`--dex`；`--uri`；`--image`                                                                                                                            |

## `tx` — 广播与 Gas

| 子命令            | 用途                   | 选项                                                   |
| -------------- | -------------------- | ---------------------------------------------------- |
| `send`         | 广播已签名交易              | `--chain`；`--signed-tx`；`--submit-type`；`--anti-mev` |
| `gas-price`    | 当前 Gas 价格（仅 EVM）     | `--chain`（`eth` \| `bsc`）                            |
| `estimate-gas` | 估算 EVM 调用的 gas limit | `--chain`；`--from`；`--to`；`--data`；`--value`         |

## `job` — 异步任务轮询

| 子命令      | 用途      | 选项                          |
| -------- | ------- | --------------------------- |
| `status` | 查询长任务状态 | `--id`；`--wait`；`--timeout` |

## `graphql` — GraphQL schema 与查询

完整用法参见 [接入方式 → CLI → GraphQL 子命令](/cn/docs/access-methods/cli#graphql-subcommand) 以及 [chainstream-graphql Agent Skill](/cn/docs/ai-agents/agent-skills/chainstream-graphql)。

| 子命令      | 用途                    | 选项                                               |
| -------- | --------------------- | ------------------------------------------------ |
| `schema` | 探索 schema（cube、类型、字段） | `--summary`；`--type <cube>`；`--full`；`--refresh` |
| `query`  | 执行 GraphQL 查询         | `--query <gql>`；`--file <path>`；`--var <json>`   |

## `plan` — 订阅与 x402 自动扣费

| 子命令        | 用途                                                   | 选项                    |
| ---------- | ---------------------------------------------------- | --------------------- |
| `status`   | 当前套餐、剩余配额与用量                                         | `--chain`；`--address` |
| `purchase` | 通过 x402 / MPP 购买套餐（自动把返回的 API key 保存到 `config.json`） | `--plan`              |

## `config` — 本地配置

| 子命令    | 用途       | 选项                                                        |
| ------ | -------- | --------------------------------------------------------- |
| `set`  | 设置一项配置   | `--key`（`apiKey` \| `baseUrl` \| `walletChain`）；`--value` |
| `get`  | 显示当前配置   | `--key`（可选）                                               |
| `auth` | 显示当前认证状态 | —                                                         |

## 退出行为

* `0` — 成功（或空结果）
* `1` — 用户可见错误，JSON payload 输出到 stdout（除非关闭 `--json`，此时打印格式化错误）
* 认证失败（`401`）、需要付费（`402`）或网络错误时非零退出

任何数据 / GraphQL 命令返回 402 时，CLI 会提示你执行 `wallet pricing` 与 `plan purchase`。`plan purchase` 本身会透明处理 x402 自动扣费。

## 下一步

<CardGroup cols={2}>
  <Card title="接入方式 → CLI" icon="terminal" href="/cn/docs/access-methods/cli">
    叙述式用法：安装、认证、上手、GraphQL 子命令。
  </Card>

  <Card title="Agent Skills" icon="brain" href="/cn/docs/ai-agents/agent-skills/introduction">
    AI Agent 如何驱动 CLI。
  </Card>

  <Card title="x402 支付" icon="credit-card" href="/cn/docs/platform/billing-payments/x402-payments">
    `plan purchase` 与即时 402 处理的工作方式。
  </Card>

  <Card title="GraphQL" icon="diagram-project" href="/cn/docs/access-methods/graphql">
    GraphQL 接口的端点、schema 与认证。
  </Card>
</CardGroup>
