Create or Import Config Files¶
Creating a new strategy file¶
create command and answer the prompts to configure your bot's behavior depending on the strategy you want to use.
The last prompt will ask you to enter a name for the config file. You can also specify the name of your file at the beginning by running
create [file_name] command.
Config file templates¶
These configuration files created and used by Hummingbot are saved in the
conf/ directory of your instance, which you can edit directly with a standard text editor.
- Installed from source:
- Installed via Docker:
hummingbot_filesis the default name of the parent directory. This can be different depending on the setup when the instance was created.
- Installed via Binary (Windows):
- Installed via Binary (MacOS):
The template configuration files can be found here: Config Templates.
Exit Hummingbot and ensure it is not running when you modify the config files. Changes will take effect the next time Hummingbot is started.
create command initializes the configuration of global and strategy-specific settings necessary to run the bot.
Running this command will automatically create the following files in these folders:
||Global configuration settings, e.g. Binance API keys and Ethereum node.|
||Settings for the pure market making strategy.|
||Settings for the cross-exchange market making strategy.|
||Settings for the liquidity mining strategy.|
||Settings for the perpetual market making strategy.|
||Settings for the arbitrage strategy.|
||Settings for the celo arbitrage strategy.|
||Settings for the amm arbitrage strategy.|
||Settings for the spot perpetual arbitrage strategy.|
||Settings for the avellaneda market making strategy.|
For editing configuration files directly, once they are created, you may find it easier to edit the configuration files in the
conf/ folder. Simply open them with a text editor and make any desired modifications.
create command, you need to setup a strategy along with its parameters.
We have developed walkthroughs for each strategy:
- Pure market making
- Cross-exchange market making
- Perpetual Market Making
- Celo Arbitrage
- AMM Arbitrage
- Liquidity Mining
- Spot Perpetual Arbitrage
- Avellaneda Market Making
When configuring your bot, make sure you are aware of your exchange's minimum order sizes and fees, and check that your trading pair has sufficient order book and trading volumes. You can find more info about specific exchanges in the Connectors section.
Import an existing strategy file¶
- Enter the name of your strategy config file
You can also skip the prompt by running
import [file_name] command.
Press TAB to scroll through the auto-complete selections.
config after importing a strategy file. This will be applicable for all imported strategies.
What to auto-fill in the prompt after each import command? (start/config) >>>
autofill_import = start
1 2 3 4 5 6 7 8 9 10 11
>>>`import conf_pure_mm_1.yml` Configuration from conf_pure_mm_1.yml file is imported. Preliminary checks: - Exchange check: All connections confirmed. - Strategy check: All required parameters confirmed. -All checks: Confirmed. Enter "start" to start market making >>> start
Here's an example if using the config command
autofill_import = config
1 2 3 4 5 6 7 8 9 10 11
>>>`import conf_pure_mm_1.yml` Configuration from conf_pure_mm_1.yml file is imported. Preliminary checks: - Exchange check: All connections confirmed. - Strategy check: All required parameters confirmed. -All checks: Confirmed. Enter "start" to start market making >>> config
Create command shortcuts¶
To use this feature, open and configure
Import the lines of code to create a custom command shortcut.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
# Command Shortcuts # Define abbreviations for often used commands # or batch grouped commands together command_shortcuts: # Assign shortcut command command: spreads_refresh # Reference help: Set bid spread, ask spread, and order refresh time # Argument Label arguments: [Bid Spread, Ask Spread, Order Refresh Time] # Original config output with value output: [config bid_spread $1, config ask_spread $2, config order_refresh_time $3]
Custom made commands can only be used once a strategy has been imported.