https://github.com/espressif/idf-im-cli

ESP-IDF Installation Manager - CLI
https://github.com/espressif/idf-im-cli

Last synced: 2 days ago
JSON representation

ESP-IDF Installation Manager - CLI

• Host: GitHub
• URL: https://github.com/espressif/idf-im-cli
• Owner: espressif
• License: apache-2.0
• Created: 2024-06-21T05:45:26.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-23T10:52:52.000Z (4 days ago)
• Last Synced: 2024-09-23T15:31:45.680Z (3 days ago)
• Language: Rust
• Homepage:
• Size: 562 KB
• Stars: 5
• Watchers: 6
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.MD
  • License: LICENSE

Awesome Lists containing this project

README

        
# ESP-IDF Installation Manager(EIM) - CLI

EIM is a cross-platform CLI application that simplifies the setup process for ESP-IDF (Espressif IoT Development Framework). Whether you’re working on macOS, Linux, or Windows, EIM offers a consistent and user-friendly experience for installing prerequisites, ESP-IDF itself, and essential development tools.

Please check the complete documentation [here](https://preview-docs.espressif.com/projects/idf-im-cli/en/latest/index.html).

## Configuration

There are several ways how to configure the installer, you can supply a config file, specify cli arguments, set environmental variables or go through a wizard on the command line.

The precedence is that the config file is overwritten by env variables which can be overridden by cli arguments.

If you go through the wizard, your choices will have the higher precedence.

### File

the installer takes the config toml file. it searches for it in the default location ./config/default.toml but you can specify the path to the config with `--config` cli argument

example config:

```toml

path = "/tmp/esp-new/"

idf_path = "/tmp/esp-new/v5.3/esp-idf"

tool_download_folder_name = "dist"

tool_install_folder_name = "tools"

target = ["all"]

idf_versions = ["v5.3"]

tools_json_file = "tools/tools.json"

idf_tools_path = "./tools/idf_tools.py"

mirror = "https://github.com"

idf_mirror = "https://github.com"

recurse_submodules = false

```

### Env variables

you can override any of the settings by exporting env variable prefixed by `ESP_` like `ESP_TARGET`

### Cli

please refer to the --help for information about cli usage

## How to run

Download the executable for the suitable architecture.

it is recommended first to run the `--help` command 

Run it and proceed according to instructions in the terminal and you will have IDF installed.

for Chinese run it with the flag `-l=cn`