Skip to content

Install from Source (Windows)

The instructions below help you install a standalone Hummingbot instance from source on a Windows machine.

Watch the video:

Prerequisites

Windows Subsystem for Linux 2 (WSL 2)

Hummingbot is designed for Unix-based environment such as macOS or Linux, so Windows users should first install Windows Subsystem for Linux 2 (WSL 2) before installing Hummingbot from source.

Note that:

  • You must be running Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
  • Virtualization needs to be enabled under your BIOS setting.

To troubleshoot WSL issues, see this link

1. Open Powershell as admin

Search for "Powershell" on the start menu, right-click and "run as admin"

Powershell start

2. Run the Install WSL commmand

wsl --install

By default, WSL uses the Ubuntu distribution of Linux, which is compatible for Hummingbot.

3. Start WSL

After the installation, just type wsl on the Powershell or on the Command prompt.

Note that the first time WSL is executed, you will be asked to create a new default username/password.

4. Install Ubuntu from Windows Store

Alternatively, after WSL is installed, search for Ubuntu in the Windows Store and install it as an app in the Start menu. That way, you don't have to run Powershell every time you use Hummingbot.

Powershell distros

Install Hummingbot

Open the Ubuntu terminal and install Hummingbot from source following the Linux instructions or run the commands below:

git clone https://github.com/hummingbot/hummingbot
cd hummingbot
./install
conda activate hummingbot
./compile

Launch Hummingbot

From inside the conda environment, run the following command to launch Hummingbot:

./start

You should see the Hummingbot welcome screen:

welcome screen

To get started with Hummingbot, check out the following docs:

If you need to run DEX bots, install Hummingbot Gateway.

Other Useful Commands

Update Hummingbot to latest master release

git pull origin master

Update Hummingbot to development branch

git pull origin development

Removed compiled files

./clean

Remove hummingbot conda environment

./uninstall