cli.md

Command Line Interface

The bot can be controlled from the command line.

Command line format

bin/mmbot [-vdt] -f <config_file> <cmd> <args...>

Switches must appear before the because all arguments after the are passed as arguments of the command.

Switches

Switch -v

Redirects log to stderr ("verbose mode"). This switch cannot be used when the bot starts in daemon mode

Switch -d

Temporarily enforces debug mode of logging ("debug")

Switch -t

Enforces dry_run=1 for all trading pairs ("test")

Switch -f

Changes location of configuration file. Default location is at path ../conf/mmbot.conf relative to bot's binary file

Service control commands

start

Starts the Bot in daemon mode

stop

Stops the running Bot

restart

Restarts the running Bot (combination of stop+start)

status

Shows status of the Bot

pidof

If the Bot is already running, it shows its PID

wait

Holds until the Bot is stopped

logrotate

Closes and re-opens logs. Useful as postrotate action of logrotate

Bot's control commands

calc_range

Calculates available trading range (min and max price) for each trading pair.

get_all_pairs <broker>

Prints all trading pairs for given broker

$ bin/mmbot get_all_pairs poloniex

erase_trade <trader> <trade-id>

Erases single trade from the history. It is usefull when you need to hide a trade executed out of strategy.Erased trade disappears from charts and calculations.

To retrieve click and hold on trade line in the web browser.

You cannot erase the most recent trade, because it is used to find last trade-id. So if the recent trade is erased, it reappears after a while

The effect of the deletion can be seen in web browser after 2 or 3 minutes

resync_trades_from <trader> <trade-id>

Erases all recent trades starting by specified . This causes that the Bot resynces all missing trades from the stockmarket.

To retrieve click and hold on trade line in the web browser.

The function doesn't work in dry_run mode. It cannot perform the resync after erase.

reset <trader>

Erases all trades expect the last one. It useful to reset statistics and start over again

achieve <trader> <price> <amount>

Enters to an achieve mode. In this mode, the robot tries to achieve specified state on the account.

The achieve mode is finished once the state of the account is achieved.

This function can be used to buy initial coins to initalize the trader. The price and the amount both specify initial settings of internal calculatir. If the price is different than current price on the stockmarket, the final amount will be adjusted to achieve correct calculations.

Once the achive mode is enabled, the robot starts to generete orders to achieve the required state quickly as possible, but it still generates LIMIT (maker) orders. During achieve mode, the accumulation settings are ignored. Any changes in balance or manual orders can cause generation of reverting order. All trades created during achieve mode are marked as manual (even if detect_manual_trades is disabled).

To cancel achieve mode simply call this command again and specify current price and current balance on the stockmarket account. It causes, that internal state becomes immediatelly achieved.