CLI Reference

Use command help for the flags supported by the installed version:

mlab --help
mlab <command> --help
mlab <command> <subcommand> --help

Markets

mlab markets [--provider mmt] --exchange <exchange> [--hip <1|4>] [--refresh] [--symbol <symbol>]

Hyperliquid requires --hip 1 for Spot discovery or --hip 4 for outcome discovery. HIP-4 listings also accept --search, --deployer, and --testnet. BULK listings accept --testnet for the public testnet catalog.

See Markets.

Source

mlab source <source> [flags]

Sources: orderbook, trades, candles, volumes, vd, oi, funding, stats.

See Sources.

Study

mlab study <study> [flags]

Studies: spread, depth, imbalance, slippage, vamp, cvd.

See Studies.

Execution

mlab trade long <symbol> [flags]
mlab trade short <symbol> [flags]
mlab trade buy <pair> [flags]
mlab trade sell <pair> [flags]

mlab positions [flags]
mlab orders [flags]
mlab fills [flags]
mlab cancel <symbol> <order-id> [flags]
mlab close <symbol> [flags]

See Execution.

Outcome Actions

mlab outcome split <outcome-id> --amount <amount>
mlab outcome merge <outcome-id> [--amount <amount>]
mlab outcome merge-question <question-id> [--amount <amount>]
mlab outcome negate <question-id> <outcome-id> --amount <amount>

See Hyperliquid outcomes.

Strategy

mlab strategy run <twap|vwap|oiwap> <symbol> [flags]
mlab strategy jobs
mlab strategy status <job-id>
mlab strategy logs <job-id> --follow
mlab strategy stop <job-id>

See Strategies.

Bot

mlab bot run <mid-price|volume-mid|grid> <symbol> [flags]
mlab bot jobs
mlab bot status <job-id>
mlab bot logs <job-id> --follow
mlab bot stop <job-id>

See Bots.

Notebook

mlab notebook [--python <path>] [--no-browser]

Starts a local JupyterLab research session with Market Lab history and study helpers. See Jupyter Notebook.

Script

mlab script backtest <path> [flags]
mlab script run <path> [flags]
mlab script jobs
mlab script status <job-id>
mlab script logs <job-id> --follow
mlab script stop <job-id>
mlab script runs list
mlab script runs show <run-id>

See Python Scripting V2 or JavaScript Scripting.

Auth

mlab auth set <provider>
mlab auth status
mlab auth remove <provider>

See Authentication.

Configuration

mlab <command> --config ./marketlab.toml

See Configuration.

Daemon

mlab daemon backend [native|docker]
mlab daemon start
mlab daemon status
mlab daemon events
mlab daemon stop

See Daemon.

Transport

mlab remote use <user@host|local>
mlab remote list
mlab remote status
mlab remote test <user@host>
mlab remote remove <user@host>
mlab --remote <user@host|local> <command>

See Transport.

Health and Status

mlab health [--provider mmt] --exchange <exchange>
mlab status

Upgrade

mlab upgrade --check
mlab upgrade

See Installation.

Common Output Flags

--output terminal
--output json
--output jsonl
--yes

See JSON Output.

On this page