Config Commands

Reference for the idf-ci config command group. For configuration resolution rules and override precedence, see idf-ci Configuration.

config show

The show command prints the value for a dot-path key and reports where that value came from. It also prints the config file path used (if any).

idf-ci config show gitlab.build_pipeline.runs_per_job

Expected output includes:

Config file path (or <not found> if discovery failed)
Source (CLI override, config file, or default)
Value rendered as TOML

config explain

The explain command reports the type, default, and description for a key. If the key points to a section, it lists available subkeys.

idf-ci config explain gitlab.build_pipeline

For leaf keys, explain prints the default value in TOML format. If the key accepts a fixed set of values, it also lists the choices.

Use dot-path syntax for nested keys, for example gitlab.build_pipeline.runs_per_job.

config get-modified-components

The get-modified-components command finds which ESP-IDF components changed based on a list of modified files.

It uses component_mapping_regexes and component_ignored_file_extensions from your CI configuration (.idf_ci.toml) to map file paths to component names.

# Pass modified files as a semicolon-separated string
idf-ci config get-modified-components --modified-files "components/esp_wifi/src/wifi.c;components/nvs_flash/src/nvs.c"

# Use with git diff in CI scripts
MODIFIED_FILES=$(git diff --name-only origin/master...HEAD | tr '\n' ';')
idf-ci config get-modified-components --modified-files "$MODIFIED_FILES"

Options:

--modified-files: Semicolon-separated list of modified file paths.

Output:

Prints each modified component name on a new line. Files with ignored extensions (such as .md or .rst) and files outside component directories are skipped automatically.