MarketlabMarketlabDocs

CLI Reference

Find Market Lab commands and their dedicated documentation.

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 balance --venue <bulkf|hyperliquidf|hyperlinkf> [--testnet] [--output=json]
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.

Pools

mlab pool list --limit 10 --offset 0
mlab pool inspect <pool-address>
mlab pool position <pool-address> --account <wallet> --output json
mlab pool create --account <wallet> --token-a <token-address> --token-b <token-address> --output json
mlab pool created <transaction-hash> --account <wallet> --output json
mlab pool deposit <pool-address> --account <wallet> --amount0 <base-units> --amount1 <base-units> --output json
mlab pool swap <pool-address> --account <wallet> --token-in <token-address> --amount-in <base-units> --output json
mlab pool withdraw <pool-address> --account <wallet> --shares <base-units> --output json
mlab pool authorize <pool-address> --account <wallet> --operator <operator-address> --output json
mlab pool operator create
mlab pool operator address
mlab pool run <pool-address> --dry-run
mlab pool jobs
mlab pool logs <job-id> --limit 20
mlab pool stop <job-id>

Wallet actions prepare unsigned transactions; the wallet signs and sends them. pool run manages fees, not trading orders. See Pools for usage and amount units.

Bonding Markets

Use mlab curve for token-allocation markets settled in native HYPE. On-chain commands require --factory; wallet actions prepare unsigned transactions.

CommandsPurpose
create, list, inspectOpen and discover markets
quote, buy, sellQuote or prepare a trade
claim-feesPrepare a manager fee withdrawal
operator, authorize, runSet up and start automatic fees
jobs, logs, stopInspect or stop fee jobs

See Bonding markets for complete commands, amount units and signing steps.

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 precheck <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>

precheck is for sandboxed Linux servers. See server sandbox and precheck.

See Python Scripting V2 or JavaScript Scripting.

Alerts

mlab alert setup
mlab alert setup --chat-id <numeric-chat-id>
mlab alert status
mlab alert test
mlab alert remove

Setup privately prompts for the Telegram token and connects your DM with a one-time code. --chat-id is optional for groups or an existing chat ID. Python alert inputs and examples.

Auth

mlab auth set <provider>
mlab auth set <bulk|hyperliquid|hyperlink> --agent --account <OWNER_ADDRESS>
mlab auth status
mlab auth remove <provider>

See Authentication to configure credentials or use an existing agent.

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

Docker configuration options:

MLAB_HOME="$HOME/mlab-runtimes/alice" mlab daemon backend docker \
  --container mlab-alice --port 48001 \
  --cpus 1 --memory-mib 512 --pids-limit 256

Set MLAB_HOME to select a separate runtime home before configuring it. These options, and --image, require the Docker backend. Omitted options preserve existing settings; changing settings requires stopping active jobs and managed orders first.

See Daemon and Independent Runtimes.

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