The Hummingbot Client
Hummingbot uses a command-line interface (CLI) that helps users configure and run the bot, as well as generate logs of the trades performed.
Installed from Docker
Creating a new instance of
docker run will automatically start the
hummingbot client (see Docker - Create new instance of hummingbot).
To run a previously created, stopped container:
docker start $NAME && docker attach $NAME
Installed from source
Make sure that you activate the Anaconda environment with
conda activate hummingbot prior to running Hummingbot.
Open a Terminal window and go to the root of the directory that contains Hummingbot. From there, run:
The CLI is divided into three panes:
- Input pane (lower left): where users enter commands
- Output pane (upper left): prints the output of the user's commands
- Log pane (right): log messages
||Prints a list of available commands.|
||Starts the bot. If any configuration settings are missing, it will automatically prompt you for them.|
||Configure the bot. When running for the first time, initializes the bot. If the bot has already been initialized, unlocks the Ethereum wallet.|
||Get a status report about price differential between the two exchanges, as well as current orders.|
||List wallets, exchanges, configs, and completed trades.
*Example usage: `list [wallets
||Get detailed information about wallets, exchanges, and orders.
*Example usage: `describe [-w
||Gets the balance of an exchange or wallet.
*Example usage: `get_balance [-c WETH -w
||Cancels all orders, saves the log, and exits Hummingbot.|
||Force quit without cancelling orders.|
||Cancels all outstanding orders and stops the bot.|
||Print your ethereum wallet private key.|