Getting Started

Supported ESP-IDF Versions

The IDF Component Manager requires ESP-IDF v4.1 and later.

The IDF Component Manager is included and enabled by default in all ESP-IDF versions starting with v4.4. For older minor versions of ESP-IDF, the component manager is enabled by default in the following bugfix releases:

• ESP-IDF v5.x and later

• ESP-IDF v4.4.x and later

• ESP-IDF v4.3.3 and later

• ESP-IDF v4.2.4 and later

Warning

If you are using ESP-IDF versions 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.3.0, 4.3.1, or 4.3.2, you need to install the IDF Component Manager manually. See Installing the IDF Component Manager.

Checking the IDF Component Manager Version

If you don’t know whether your version of ESP-IDF includes the IDF Component Manager, you can check the version of the IDF Component Manager.

To check the installed version of the IDF component manager, first, activate the ESP-IDF environment, then run the help command:

WindowsmacOS and Linux (bash or zsh)macOS and Linux (fish)

Run ESP-IDF PowerShell Environment or ESP-IDF Command Prompt (cmd.exe) from the Start menu and run the following command:

> python -m idf_component_manager -h

Recent versions of the component manager also support the compote version command. If the compote command is not available in your IDF Component Manager, please consider upgrading it to the latest version. See Upgrading the IDF Component Manager.