Espressif ESP32-S2 Programming Manual page 1477

Chapter 4. API Guides
Export scripts
Since the installed tools are not permanently added into the user or system PATH environment variable, an extra step
is required to use them in the command line. The following scripts modify the environment variables in the current
shell to make the correct versions of the tools available:
• export.bat for Windows Command Prompt
• export.ps1 for Powershell
• export.sh for Bash
Note: To modify the shell environment in Bash, export.sh must be "sourced": . ./export.sh (note the
leading dot and space).
export.sh may be used with shells other than Bash (such as zsh). However in this case the IDF_PATH environ-
ment variable must be set before running the script. When used in Bash, the script will guess the IDF_PATH value
from its own location.
In addition to calling idf_tools.py, these scripts list the directories which have been added to the PATH.
Other installation methods
Depending on the environment, more user-friendly wrappers for idf_tools.py are provided:
• IDF Tools installer for Windows
py.
• Eclipse plugin for ESP-IDF
py.
• Visual Studio Code extension for ESP-IDF includes an onboarding flow. This flow helps setting up the tools.
Although the extension does not rely on idf_tools.py, the same installation method is used.
Custom installation
Although the methods above are recommended for ESP-IDF users, they are not a must for building ESP-IDF appli-
cations. ESP-IDF build system expects that all the necessary tools are installed somewhere, and made available in
the PATH.
List of IDF Tools
xtensa-esp32-elf Toolchain for Xtensa (ESP32) based on GCC
License: GPL-3.0-with-GCC-exception
More info: https://github.com/espressif/crosstool-NG
Espressif Systems
can download and install the tools. Internally the installer uses idf_tools.
includes a menu item to set up the tools. Internally the plugin calls idf_tools.
1466
Submit Document Feedback
Release v4.4