ritmex-bot

Language Setting: Set LANG=en in your .env file to display the CLI interface in English.

A Bun-powered multi-exchange perpetuals workstation that ships an SMA30 trend engine, a Guardian stop sentinel, and two market-making modes. It offers instant restarts, realtime market data, structured logging, and an Ink-based CLI dashboard.

If you'd like to support this project and get fee discounts, please consider using these referral links:

• Lighter Robinhood Chain referral link — 10% bonus points
• Lighter referral link
• Hyperliquid referral link
• Ondo Perps referral link
• Aster referral link
• StandX referral link
• Binance referral link
• Nado referral link
• Backpack referral link
• edgex referral link
• Paradex referral link
• Apex referral link
• GRVT referral link

CLI Command Mode (ritmex-bot)

ritmex-bot provides an agent-friendly command interface for exchange capability checks, market data, account/position queries, order operations, and strategy execution.

• It keeps the current environment-variable system intact: no renaming and no new required keys.
• --symbol is passed through exactly as provided (no symbol normalization).
• It supports --dry-run simulation and --json structured output for automation.

Install This Project Skill (skills add)

bunx skills add https://github.com/discountry/ritmex-bot --skill use-ritmex-bot

If you need a specific branch/tag, append --ref <branch-or-tag>.

Full guide: ritmex-bot CLI User Guide (English)

Documentation Map

• ritmex-bot CLI User Guide (English)
• ritmex-bot CLI 使用手册（中文）
• Beginner-friendly Quick Start
• Grid Trading Strategy Guide
• Bilingual Exchange Configuration Guides
• Ondo Perps Integration Guide

Highlights

• Live data & risk sync via websockets with REST fallbacks and full reconciliation on restart.
• Trend strategy featuring SMA30 entries, fixed stop loss, trailing stop, Bollinger bandwidth gate, and profit-lock stepping.
• Guardian strategy that never opens trades but mirrors your live exposure, ensuring every position has a synced stop loss and trailing stop.
• Market-making loop with dual-sided quote chasing, loss caps, and automatic order healing.
• Modular architecture decoupling engines, exchange adapters, and the Ink CLI for easy venue or strategy extensions.

Supported Exchanges

Requirements

• Bun >= 1.2 (both bun and bunx on PATH)
• macOS, Linux, or Windows via WSL (native Windows works but WSL is recommended)
• Node.js is optional unless your tooling requires it

Quick Start

One-line bootstrap (macOS / Linux / WSL)

curl -fsSL https://github.com/discountry/ritmex-bot/raw/refs/heads/main/setup.sh | bash

The script installs Bun, project dependencies, collects Aster API credentials, generates .env, and launches the CLI. Prepare the relevant exchange API keys before running it.

Manual installation

1. Clone the repository bash git clone https://github.com/discountry/ritmex-bot.git cd ritmex-bot Alternatively, download the ZIP from GitHub and extract it manually.
2. Install Bun
3. macOS / Linux: curl -fsSL https://bun.sh/install | bash
4. Windows PowerShell: powershell -c "irm bun.sh/install.ps1 | iex" Re-open the terminal and verify bun -v prints a version.
5. Install dependencies bash bun install
6. Create your environment file bash cp .env.example .env Edit .env with the exchange credentials and overrides you plan to use.
7. Launch the CLI bash bun run index.ts Use the arrow keys to pick a strategy, Enter to start, Esc to go back, and Ctrl+C to exit.

Shared Configuration

.env.example captures all defaults; the most common settings are summarised below.

CLI flags override environment variables at runtime: bash bun run index.ts --exchange grvt --strategy maker bun run index.ts -e lighter -s offset-maker --silent

Exchange Setup Guides

Each supported exchange has a standalone Chinese and English configuration guide covering credential creation, required variables, environment selection, symbol formats, read-only verification, and security controls.

Command Cheatsheet

bun run index.ts   # Launch the CLI (default entrypoint)
bun run start      # Alias for bun run index.ts
bun run dev        # Development entrypoint
bun run lint       # Run Oxlint checks
bun run lint:fix   # Apply safe Oxlint fixes
bun x vitest run   # Execute the full Vitest suite

ritmex-bot Command Mode (Agent-friendly)

The project now supports a standalone command mode with the command name ritmex-bot:

ritmex-bot doctor
ritmex-bot exchange list
ritmex-bot market ticker --exchange binance --symbol BTCUSDT
ritmex-bot order create --exchange binance --symbol BTCUSDT --side buy --type limit --quantity 0.01 --price 90000 --dry-run
ritmex-bot strategy run --strategy maker --exchange standx --silent --dry-run

Run Modes

# Global install
bun add -g ritmex-bot
ritmex-bot doctor

# No install
bunx ritmex-bot doctor

Global Flags

• --exchange: picks exchange using the existing env/config logic
• --symbol: passed through as-is (no symbol normalization)
• --dry-run: simulation mode (no real create/cancel side effects)
• --json: structured JSON output for AI agents
• --timeout: command timeout in milliseconds

Silent & Background Execution

Direct silent launch

Skip the Ink menu and start a strategy directly:

bun run index.ts --strategy trend --silent
bun run index.ts --strategy maker --silent
bun run index.ts --strategy offset-maker --silent

Combine with --exchange/-e to pin the venue for that run.

Package scripts

Convenience aliases exposed via package.json:

bun run start:trend:silent
bun run start:maker:silent
bun run start:offset:silent

Daemonising with pm2

Install pm2 locally (e.g. bun add -d pm2) and launch the process:

bunx pm2 start bun --name ritmex-trend --cwd . --restart-delay 5000 -- run index.ts --strategy trend --silent

You can also call the bundled scripts:

bun run pm2:start:trend
bun run pm2:start:maker
bun run pm2:start:offset

Run pm2 save afterwards if you want the process list to survive reboots.

Testing

Powered by Vitest:

bun run lint
bun run lint:fix
bun run test
bun x vitest --watch

Troubleshooting

• Keep at least 50-100 USDT in the account before deploying a live strategy.
• Configure leverage on the exchange manually (~50x is recommended); the bot will not change it.
• Ensure your server or workstation clock is in sync to avoid signature errors.
• Accounts must run in one-way position mode.
• Env not loading: make sure .env lives in the repo root and variable names are spelled correctly.
• Permission rejected: confirm the API key has perpetual trading scopes enabled.
• Precision errors: align PRICE_TICK, QTY_STEP, and TRADE_SYMBOL with the exchange filters. See simple-readme.md for more detailed walkthroughs.

Community & Support

• Telegram: https://t.me/+4fdo0quY87o4Mjhh
• Issues and PRs are welcome for bug reports and feature requests

Disclaimer

Algorithmic trading carries risk. Validate strategies with paper trading or small capital first, safeguard your API keys, and only grant the minimum required permissions.