use-ritmex-bot

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Use ritmex-bot CLI

使用ritmex-bot CLI

This skill is for running

ritmex-bot

in an agent-safe, exchange-compatible way.

本技能用于以Agent安全、兼容交易所的方式运行

ritmex-bot

。

Use This Skill When

何时使用本技能

The user asks to use
```
ritmex-bot
```
commands directly.
The user wants market data, account/position, or order operations from supported exchanges.
The user wants AI-agent-friendly CLI execution with
```
--json
```
output.
The user wants simulation with
```
--dry-run
```
before real writes.

用户要求直接使用
```
ritmex-bot
```
命令。
用户需要从支持的交易所获取市场数据、账户/仓位信息或进行订单操作。
用户需要适合AI Agent的CLI执行方式，并使用
```
--json
```
输出。
用户希望在实际执行前通过
```
--dry-run
```
进行模拟。

Hard Rules

硬性规则

Do not change environment-variable names and do not invent new env keys.
Read config from the current shell environment as-is.
Do not normalize or rewrite
```
--symbol
```
; pass it through exactly.
If a feature is not supported by an exchange, return it as unsupported (
```
UNSUPPORTED
```
), do not fake behavior.
For write actions (
```
order create
```
,
```
order cancel
```
,
```
order cancel-all
```
), prefer
```
--dry-run
```
first unless the user explicitly asks to skip simulation.
Use
```
--json
```
whenever output must be consumed by another agent/tool.

不要修改环境变量名称，也不要创建新的环境变量键。
直接从当前Shell环境读取配置，不做修改。
不要标准化或重写
```
--symbol
```
参数，完全按用户提供的内容传递。
如果交易所不支持某功能，直接返回“不支持（UNSUPPORTED）”，不要模拟该功能的行为。
对于写入操作（
```
order create
```
、
```
order cancel
```
、
```
order cancel-all
```
），除非用户明确要求跳过模拟，否则优先使用
```
--dry-run
```
。
当输出需要被其他Agent/工具消费时，务必使用
```
--json
```
。

Command Entry Options

命令入口选项

Use one of these:

bash

ritmex-bot <command>
npx ritmex-bot <command>
bunx ritmex-bot <command>
bun run index.ts <command>

ritmex-bot

is unavailable, use

bun run index.ts <command>

from repo root.

使用以下方式之一：

bash

ritmex-bot <command>
npx ritmex-bot <command>
bunx ritmex-bot <command>
bun run index.ts <command>

如果

ritmex-bot

不可用，从代码库根目录使用

bun run index.ts <command>

。

Default Agent Workflow

默认Agent工作流

Determine exchange and symbol from user request.
If missing, rely on existing env resolution; do not create fallback env variables.

Run capability precheck:

```
exchange list
```
```
exchange capabilities --exchange <id>
```

For read operations, run command directly (prefer
```
--json
```
).
For write operations:
- Run the exact command with
```
--dry-run --json
```
  .
- Validate payload and dry-run actions.
- Run live command only when user confirmed or explicitly requested live execution.
Post-check with
```
order open
```
,
```
position list
```
, or
```
account snapshot
```
as needed.

从用户请求中确定交易所和交易对。
如果信息缺失，依赖现有环境变量解析结果；不要创建 fallback 环境变量。

运行功能预检查：

```
exchange list
```
```
exchange capabilities --exchange <id>
```

对于只读操作，直接运行命令（优先使用
```
--json
```
）。
对于写入操作：
- 使用
```
--dry-run --json
```
  运行完整命令。
- 验证负载和模拟操作。
- 仅在用户确认或明确要求实时执行时，运行真实命令。
根据需要运行
```
order open
```
、
```
position list
```
或
```
account snapshot
```
进行事后检查。

Global Flags

全局标志

Flag	Short	Meaning
`--exchange`	`-e`	Exchange override
`--symbol`	-	Trading symbol (pass-through)
`--json`	`-j`	JSON output
`--dry-run`	`-d`	Simulate write ops
`--timeout`	`-t`	Timeout in ms (default 25000)
`--help`	`-h`	Show help

标志	缩写	含义
`--exchange`	`-e`	覆盖交易所
`--symbol`	-	交易对（原样传递）
`--json`	`-j`	JSON格式输出
`--dry-run`	`-d`	模拟写入操作
`--timeout`	`-t`	超时时间（毫秒，默认25000）
`--help`	`-h`	显示帮助信息

Root Commands

根命令

```
help
```
```
doctor
```
```
exchange
```
```
market
```
```
account
```
```
position
```
```
order
```
```
strategy
```

```
help
```
```
doctor
```
```
exchange
```
```
market
```
```
account
```
```
position
```
```
order
```
```
strategy
```

Command Reference

命令参考

doctor

doctor

命令

bash

ritmex-bot doctor
ritmex-bot doctor --exchange binance --symbol BTCUSDT --json

Returns effective setup and runtime capabilities.

bash

ritmex-bot doctor
ritmex-bot doctor --exchange binance --symbol BTCUSDT --json

返回当前的有效配置和运行时功能。

exchange

exchange

命令

bash

ritmex-bot exchange list
ritmex-bot exchange capabilities --exchange standx

If runtime adapter cannot initialize, capabilities may fallback to static metadata.

bash

ritmex-bot exchange list
ritmex-bot exchange capabilities --exchange standx

如果运行时适配器无法初始化，功能信息可能会回退到静态元数据。

market

market

命令

bash

ritmex-bot market ticker --exchange <id> --symbol <symbol>
ritmex-bot market depth --exchange <id> --symbol <symbol> --levels 10
ritmex-bot market kline --exchange <id> --symbol <symbol> --interval 1m --limit 100

Rules:

```
kline
```
requires
```
--interval
```
.
```
depth --levels
```
is optional.
```
kline --limit
```
is optional.

bash

ritmex-bot market ticker --exchange <id> --symbol <symbol>
ritmex-bot market depth --exchange <id> --symbol <symbol> --levels 10
ritmex-bot market kline --exchange <id> --symbol <symbol> --interval 1m --limit 100

规则：

```
kline
```
命令需要
```
--interval
```
参数。
```
depth --levels
```
为可选参数。
```
kline --limit
```
为可选参数。

account

account

命令

bash

ritmex-bot account snapshot --exchange <id>
ritmex-bot account summary --exchange <id>

summary

is an alias of

snapshot

bash

ritmex-bot account snapshot --exchange <id>
ritmex-bot account summary --exchange <id>

summary

是

snapshot

的别名。

position

position

命令

bash

ritmex-bot position list --exchange <id>
ritmex-bot position list --exchange <id> --symbol <symbol>

bash

ritmex-bot position list --exchange <id>
ritmex-bot position list --exchange <id> --symbol <symbol>

order

order

命令

Query open orders

查询未成交订单

bash

ritmex-bot order open --exchange <id> --symbol <symbol>

bash

ritmex-bot order open --exchange <id> --symbol <symbol>

Create order

创建订单

bash

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type limit --quantity 0.01 --price 90000

Required:

```
--side
```
=
```
buy|sell
```

--type

limit|market|stop|trailing-stop|close

```
--quantity
```
or
```
--qty
```

Conditional required:

```
limit
```
:
```
--price
```
```
stop
```
:
```
--stop-price
```

trailing-stop

--activation-price

and

--callback-rate

Optional:

```
--time-in-force
```
(
```
GTC|IOC|FOK|GTX
```
)
```
--reduce-only
```
(
```
true|false
```
)
```
--close-position
```
(
```
true|false
```
)

--trigger-type

(

UNSPECIFIED|TAKE_PROFIT|STOP_LOSS

)

```
--sl-price
```
```
--tp-price
```

bash

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type limit --quantity 0.01 --price 90000

必填参数：

```
--side
```
=
```
buy|sell
```

--type

limit|market|stop|trailing-stop|close

```
--quantity
```
或
```
--qty
```

条件必填参数：

```
limit
```
类型：
```
--price
```
```
stop
```
类型：
```
--stop-price
```

trailing-stop

类型：

--activation-price

和

--callback-rate

可选参数：

```
--time-in-force
```
（
```
GTC|IOC|FOK|GTX
```
）
```
--reduce-only
```
（
```
true|false
```
）
```
--close-position
```
（
```
true|false
```
）

--trigger-type

（

UNSPECIFIED|TAKE_PROFIT|STOP_LOSS

）

```
--sl-price
```
```
--tp-price
```

Cancel one order

取消单个订单

bash

ritmex-bot order cancel --exchange <id> --symbol <symbol> --order-id <id>

bash

ritmex-bot order cancel --exchange <id> --symbol <symbol> --order-id <id>

Cancel all

取消所有订单

bash

ritmex-bot order cancel-all --exchange <id> --symbol <symbol>

bash

ritmex-bot order cancel-all --exchange <id> --symbol <symbol>

strategy

strategy

命令

bash

ritmex-bot strategy run --strategy maker --exchange standx --silent
ritmex-bot strategy run --strategy offset --exchange binance --dry-run

Supported strategy IDs:

```
trend
```
```
swing
```
```
guardian
```
```
maker
```
```
maker-points
```
```
offset-maker
```
```
liquidity-maker
```
```
basis
```
```
grid
```

Aliases:

```
offset
```
->
```
offset-maker
```
```
makerpoints
```
/
```
maker_points
```
->
```
maker-points
```

liquidity

liquiditymaker

liquidity_maker

liquidity-maker

Extra flags:

```
--silent
```
(short alias
```
-q
```
)
```
--dry-run
```

bash

ritmex-bot strategy run --strategy maker --exchange standx --silent
ritmex-bot strategy run --strategy offset --exchange binance --dry-run

支持的策略ID：

```
trend
```
```
swing
```
```
guardian
```
```
maker
```
```
maker-points
```
```
offset-maker
```
```
liquidity-maker
```
```
basis
```
```
grid
```

别名：

```
offset
```
->
```
offset-maker
```
```
makerpoints
```
/
```
maker_points
```
->
```
maker-points
```

liquidity

liquiditymaker

liquidity_maker

liquidity-maker

额外标志：

```
--silent
```
（缩写
```
-q
```
）
```
--dry-run
```

Dry-Run First Patterns

优先模拟运行的模式

Create order safely

安全创建订单

bash

undefined

bash

undefined

1) Simulate

1) 模拟执行

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type limit --quantity 0.01 --price 90000 --dry-run --json

2) Execute live only after confirmation

2) 仅在确认后执行真实订单

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type limit --quantity 0.01 --price 90000 --json

undefined

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type limit --quantity 0.01 --price 90000 --json

undefined

Cancel safely

安全取消订单

bash

undefined

bash

undefined

1) Simulate

1) 模拟执行

ritmex-bot order cancel --exchange <id> --symbol <symbol> --order-id <id> --dry-run --json

2) Execute live

2) 执行真实取消操作

ritmex-bot order cancel --exchange <id> --symbol <symbol> --order-id <id> --json

undefined

ritmex-bot order cancel --exchange <id> --symbol <symbol> --order-id <id> --json

undefined

Agent Output Handling

Agent输出处理

Prefer

--json

and parse:

```
success
```
(boolean)
```
command
```
(executed command kind)
```
exchange
```
```
symbol
```
```
dryRun
```
```
data
```
(success payload)
```
error.code
```
,
```
error.message
```
,
```
error.retryable
```
(failure payload)

Human-readable mode is fine for manual terminal use;

--json

is preferred for automation.

优先使用

--json

并解析以下字段：

```
success
```
（布尔值）
```
command
```
（执行的命令类型）
```
exchange
```
```
symbol
```
```
dryRun
```
```
data
```
（成功返回的负载）
```
error.code
```
,
```
error.message
```
,
```
error.retryable
```
（失败返回的负载）

手动终端使用时可以使用人类可读模式；自动化场景优先使用

--json

。

Error Codes and Exit Codes

错误码与退出码

Map failures by code/exit code:

```
INVALID_ARGS
```
-> exit
```
2
```
```
MISSING_ENV
```
-> exit
```
3
```
```
UNSUPPORTED
```
-> exit
```
5
```
```
EXCHANGE_ERROR
```
-> exit
```
6
```
```
TIMEOUT
```
-> exit
```
7
```

Handling policy:

```
INVALID_ARGS
```
: fix command arguments and retry once.
```
MISSING_ENV
```
: report missing configuration; do not invent env keys.
```
UNSUPPORTED
```
: return clearly as unsupported for that exchange.
```
EXCHANGE_ERROR
```
: return details and retry only if user requests.
```
TIMEOUT
```
: optionally retry with larger
```
--timeout
```
once.

根据错误码/退出码定位问题：

```
INVALID_ARGS
```
-> 退出码
```
2
```
```
MISSING_ENV
```
-> 退出码
```
3
```
```
UNSUPPORTED
```
-> 退出码
```
5
```
```
EXCHANGE_ERROR
```
-> 退出码
```
6
```
```
TIMEOUT
```
-> 退出码
```
7
```

处理策略：

```
INVALID_ARGS
```
：修正命令参数后重试一次。
```
MISSING_ENV
```
：报告缺失的配置；不要自行创建环境变量键。
```
UNSUPPORTED
```
：明确返回交易所+不支持的方法。
```
EXCHANGE_ERROR
```
：返回详细信息，仅在用户要求时重试。
```
TIMEOUT
```
：可选使用更大的
```
--timeout
```
参数重试一次。

Symbol and Exchange-Specific Behavior

交易对与交易所特定行为

Never apply cross-exchange symbol mapping inside the skill.
Respect user-provided symbols exactly (examples:
```
BTCUSDT
```
,
```
BTCUSDC
```
,
```
BTC_USD_PERP
```
,
```
BTC-PERP
```
).
If no
```
--symbol
```
is provided, let existing exchange config resolve it.
If no
```
--exchange
```
is provided, let existing env resolution decide it.

不要在技能内部进行跨交易所的交易对映射。
完全尊重用户提供的交易对（例如：
```
BTCUSDT
```
,
```
BTCUSDC
```
,
```
BTC_USD_PERP
```
,
```
BTC-PERP
```
）。
如果未提供
```
--symbol
```
，由现有交易所配置自动解析。
如果未提供
```
--exchange
```
，由现有环境变量自动解析。

Ready-to-Use Recipes

即用型操作示例

Preflight

预检查

bash

ritmex-bot exchange list --json
ritmex-bot exchange capabilities --exchange <id> --json
ritmex-bot doctor --exchange <id> --symbol <symbol> --json

bash

ritmex-bot exchange list --json
ritmex-bot exchange capabilities --exchange <id> --json
ritmex-bot doctor --exchange <id> --symbol <symbol> --json

Read-only market/account state

只读市场/账户状态查询

bash

ritmex-bot market ticker --exchange <id> --symbol <symbol> --json
ritmex-bot market depth --exchange <id> --symbol <symbol> --levels 20 --json
ritmex-bot market kline --exchange <id> --symbol <symbol> --interval 1m --limit 120 --json
ritmex-bot account snapshot --exchange <id> --json
ritmex-bot position list --exchange <id> --symbol <symbol> --json

bash

ritmex-bot market ticker --exchange <id> --symbol <symbol> --json
ritmex-bot market depth --exchange <id> --symbol <symbol> --levels 20 --json
ritmex-bot market kline --exchange <id> --symbol <symbol> --interval 1m --limit 120 --json
ritmex-bot account snapshot --exchange <id> --json
ritmex-bot position list --exchange <id> --symbol <symbol> --json

Write flow (safe)

写入操作流程（安全模式）

bash

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type market --qty 0.01 --dry-run --json
ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type market --qty 0.01 --json
ritmex-bot order open --exchange <id> --symbol <symbol> --json

bash

ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type market --qty 0.01 --dry-run --json
ritmex-bot order create --exchange <id> --symbol <symbol> --side buy --type market --qty 0.01 --json
ritmex-bot order open --exchange <id> --symbol <symbol> --json

Strategy flow

策略运行流程

bash

ritmex-bot strategy run --strategy trend --exchange <id> --dry-run
ritmex-bot strategy run --strategy trend --exchange <id> --silent

bash

ritmex-bot strategy run --strategy trend --exchange <id> --dry-run
ritmex-bot strategy run --strategy trend --exchange <id> --silent

Completion Checklist

结果返回检查清单

Before returning results to user:

Confirm command and parameters used.
Confirm whether run was
```
dryRun
```
or live.
For live writes, provide immediate post-check output (
```
order open
```
/
```
position list
```
).
If unsupported, explicitly name exchange + unsupported method.
If failed, return error code/message and next corrective action.

向用户返回结果前：

确认使用的命令和参数。
确认是模拟运行（dryRun）还是真实执行。
对于真实写入操作，提供即时的事后检查输出（
```
order open
```
/
```
position list
```
）。
如果功能不支持，明确指出交易所+不支持的方法。
如果执行失败，返回错误码/信息以及后续纠正措施。

use-ritmex-bot

Original

Translation

Use ritmex-bot CLI

使用ritmex-bot CLI

Use This Skill When

何时使用本技能

Hard Rules

硬性规则

Command Entry Options

命令入口选项

Default Agent Workflow

默认Agent工作流

Global Flags

全局标志

Root Commands

根命令

Command Reference

命令参考

doctor

doctor命令

exchange

exchange命令

market

market命令

account

account命令

position

position命令

order

order命令

Query open orders

查询未成交订单

Create order

创建订单

Cancel one order

取消单个订单

Cancel all

取消所有订单

strategy

strategy命令

Dry-Run First Patterns

优先模拟运行的模式

Create order safely

安全创建订单

1) Simulate

1) 模拟执行

2) Execute live only after confirmation

2) 仅在确认后执行真实订单

Cancel safely

安全取消订单

1) Simulate

1) 模拟执行

2) Execute live

2) 执行真实取消操作

Agent Output Handling

Agent输出处理

Error Codes and Exit Codes

错误码与退出码

Symbol and Exchange-Specific Behavior

交易对与交易所特定行为

Ready-to-Use Recipes

即用型操作示例

Preflight

预检查

Read-only market/account state

只读市场/账户状态查询

Write flow (safe)

写入操作流程（安全模式）

Strategy flow

策略运行流程

Completion Checklist

结果返回检查清单

`doctor`

`doctor`
命令

`exchange`

`exchange`
命令

`market`

`market`
命令

`account`

`account`
命令

`position`

`position`
命令

`order`

`order`
命令

`strategy`

`strategy`
命令