espressif / idf-env

idf-env tool helps set up and manage ESP-IDF installations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation request

jmporter34 opened this issue · comments

Hi,
Could someone please add a bit more information to the readme.md ? Specifically, when I type:
idf-env config get --property python --idf-path %IDF_PATH%
where exactly is idf-env getting the requested property information from ?
Thanks

Thank you very much for the request @jmporter34 .
idf-env was evolving in order to replace platform dependent functionality of idf-installer. It's good idea to provide explanation and documentation of idf-env features.

Quick answer to your question is that idf-env is searching for esp_idf.json in directory specified by environment variable: IDF_TOOLS_PATH or in directory ~/.espressif.

You can open the configuration file by command idf-env config edit or retrieve whole configuration by idf-env config get.

The python property points to virtualenv python which is specific for IDF. That's the reason why IDF_PATH is required as parameter. Different versions of ESP-IDF uses different dependencies they are stored in separate virtualenv.