Chapter 1. Get Started
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.
Note: The GNU Make based build system requires the MSYS2 Unix compatibility environment on Windows. The
CMake-based build system does not require this environment.
Get ESP-IDF
Note: 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.4 --recursive https://github.com/espressif/esp-idf.git
ESP-IDF will be downloaded into %userprofile%\esp\esp-idf.
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
Note: The git clone option -b v4.4 tells git to clone the tag in the ESP-IDF repository git clone
corresponding to this version of the documentation.
Note: 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.
Note: 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
Tools
CMake 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”.
Espressif Systems 81
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General