For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bot Operator CLIs

Advanced. Alongside the main tokenbot CLI, each automated engine ships its own operator CLI for running and controlling that bot directly: tokenbot-mm for the market-maker and tokenbot-trading for the trading bot.

These are embedded with their respective bot services (the bots themselves run as scheduled AWS Lambda cycles). The operator CLIs reuse the same encrypted identity and local-key model as the main tokenbot CLI — run init once to register a CLI identity, then keys add to store local exchange credentials in ~/.tokenbot.

Most users never need these. Reach for them only if you operate a bot engine directly.

Both CLIs share these global options:

Flag
Description

--json

Emit machine-readable JSON instead of tables

--config <path>

Use an alternate config directory (sets TOKENBOT_HOME) instead of ~/.tokenbot

--version

Print the CLI version

--help

Show help for any command


tokenbot-mm — Market-Maker Operator

Operator surface for the market-maker engine, which runs a quoting cycle every ~5 minutes.

Setup

Command
Description

tokenbot-mm init

Generate a CLI identity and register it with TokenBot. Options: --api-url <url>, --ws-url <url>, --label <label>

tokenbot-mm keys add

Add or replace an exchange API credential (stored locally, never sent to the server). Requires --exchange <name>

tokenbot-mm keys list

List stored credential labels

tokenbot-mm keys remove --exchange <name>

Delete the stored credential for an exchange

tokenbot-mm balance --exchange <name>

Fetch exchange balance locally via CCXT

Engine control

Command
Description

tokenbot-mm status

Show current market-maker status

tokenbot-mm config show

Print the current market-maker config/status as JSON

tokenbot-mm config set <key> <value>

Update a live config key

tokenbot-mm pause

Pause the market-maker (takes effect on the next 5-minute tick)

tokenbot-mm resume

Resume the market-maker (takes effect on the next 5-minute tick)

tokenbot-mm emergency-stop --confirm

Hard-stop: cancel open orders and set the engine to halted. Requires --confirm and a typed CONFIRM prompt

Quoting & inventory

Command
Description

tokenbot-mm spreads adjust <bid_bps> <ask_bps>

Set bid/ask spreads in basis points (double-confirms before applying)

tokenbot-mm inventory

Show current inventory

tokenbot-mm analytics --window <window>

Show analytics over a time window

tokenbot-mm orderbook show

Print the latest order-book snapshot. Option: --depth <n> (default 10)

tokenbot-mm orderbook watch

Stream live order-book updates. Option: --depth <n> (default 10)


tokenbot-trading — Trading-Bot Operator

Operator surface for the trading engine, which runs a strategy cycle every ~15 minutes.

Setup

Command
Description

tokenbot-trading init

Generate a CLI identity and register it with TokenBot. Options: --api-url <url>, --ws-url <url>, --label <label>

tokenbot-trading keys add --exchange <name>

Add or replace the trading-bot exchange credential (stored locally)

tokenbot-trading keys list

List stored credential labels

tokenbot-trading keys remove --exchange <name>

Delete the stored credential (double-confirms)

tokenbot-trading balance --exchange <name>

Fetch exchange balance locally via CCXT

Strategies

Command
Description

tokenbot-trading strategy list

List all strategies registered for this account

tokenbot-trading strategy show <id>

Show a single strategy as JSON

tokenbot-trading strategy add

Create a new strategy (interactive). Options: --name, --description, --exchange-account-id

tokenbot-trading strategy enable <id>

Enable a strategy (takes effect on the next 15-minute tick)

tokenbot-trading strategy disable <id>

Disable a strategy (takes effect on the next 15-minute tick)

Activity

Command
Description

tokenbot-trading signals

Show recent trading-bot signals

tokenbot-trading signals watch

Stream live signals (currently unavailable)

tokenbot-trading positions

List currently-open positions

tokenbot-trading trades

List recent trades. Options: --strategy <id>, --symbol <pair>, --status <status>, --limit <n>

Backtests & safety

Command
Description

tokenbot-trading backtest run <input-file>

Submit a backtest defined in a JSON file

tokenbot-trading backtest results <id>

Fetch a backtest's results. Options: --export <format> (currently csv), --out <path>

tokenbot-trading emergency-stop --confirm

Hard-stop the trading bot. Requires --confirm; add --yes to skip the interactive double-confirm


Next Steps

Last updated

Was this helpful?