Setup Windows Toolchain from Scratch¶
This is a step-by-step alternative to running the ESP-IDF Tools Installer for the CMake-based build system. Installing all of the tools by hand allows more control over the process, and also provides the information for advanced users to customize the install.
To quickly setup the toolchain and other tools in standard way, using the ESP-IDF Tools installer, proceed to section Standard Setup of Toolchain for Windows.
The GNU Make based build system requires the MSYS2 Unix compatibility environment on Windows. The CMake-based build system does not require this environment.
Previous versions of ESP-IDF used the MSYS2 bash terminal command line. The current cmake-based build system can run in the regular Windows Command Prompt which is used here.
If you use a bash-based terminal or PowerShell, please note that some command syntax will be different to what is shown below.
Open Command Prompt and run the following commands:
mkdir %userprofile%\esp cd %userprofile%\esp git clone -b v4.3 --recursive https://github.com/espressif/esp-idf.git
ESP-IDF will be downloaded into
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
git clone option
-b v4.3 tells git to clone the tag in the ESP-IDF repository
git clone corresponding to this version of the documentation.
As a fallback, it is also possible to download a zip file of this stable release from the Releases page. Do not download the “Source code” zip file(s) generated automatically by GitHub, they do not work with ESP-IDF.
Do not miss the
--recursive option. If you have already cloned ESP-IDF without this option, run another command to get all the submodules:
cd esp-idf git submodule update --init
Download the latest stable release of CMake for Windows and run the installer.
When the installer asks for Install Options, choose either “Add CMake to the system PATH for all users” or “Add CMake to the system PATH for the current user”.
Ninja currently only provides binaries for 64-bit Windows. It is possible to use CMake and
idf.py with other build tools, such as mingw-make, on 32-bit windows. However this is currently undocumented.
The Ninja for Windows download is a .zip file containing a single
ninja.exe file which needs to be unzipped to a directory which is then added to your Path (or you can choose a directory which is already on your Path).
Download the latest Python for Windows installer, and run it.
The “Customise” step of the Python installer gives a list of options. The last option is “Add python.exe to Path”. Change this option to select “Will be installed”.
Once Python is installed, open a Windows Command Prompt from the Start menu and run the following command:
pip install --user pyserial
Download the precompiled Windows toolchain:
Unzip the zip file to
C:\Program Files (or some other location). The zip file contains a single directory
bin subdirectory of this directory must be added to your Path. For example, the directory to add may be
If you already have the MSYS2 environment (for use with the “GNU Make” build system) installed, you can skip the separate download and add the directory
C:\msys32\opt\xtensa-esp32s2-elf\bin to the Path instead, as the toolchain is included in the MSYS2 environment.
Adding Directory to Path¶
To add any new directory to your Windows Path environment variable:
Open the System control panel and navigate to the Environment Variables dialog. (On Windows 10, this is found under Advanced System Settings).
Path variable (either User or System Path, depending if you want other users to have this directory on their path.) Go to the end of the value, and append