How to publish package on ESP-IDF component registry

In order to upload a package to the ESP-IDF component registry, you need to follow these steps:

Create an account: First, you need to create an account on the ESP-IDF component registry website. You can do this by visiting the ESP-IDF component registry and clicking on the Log in button. You will typically login with your GitHub account.

Typically, you now want to upload your package to the staging profile.

In order to do that, first activate your ESP-IDF environment (assuming you have already installed it - otherwise, check out the Espressif EIM = ESP-IDF Installation Manager).

example.sh
source ~/.espressif/v6.0.1/esp-idf/export.sh

Then, you can use the compote tool to upload your package. The command looks like this:

example.sh
compote component upload --profile "staging" --name my_component --namespace mygithubusername

Make sure to replace my_component with the name of your component and mygithubusername with your GitHub username.

Now, if you want to upload it to the production profile (ie accessible by all), you can use the same command but remove the --profile "staging" part:

example.sh
compote component upload --name my_component --namespace mygithubusername

Check out similar posts by category: ESP-IDF, ESP32