Configuration of the IDF Component Manager

IDF Component Manager can be configured using two methods:

  1. Configuration File: A YAML file named idf_component_manager.yml that defines profiles for component management. More details about this file can be found in the Configuration File.

  2. Environment Variables: A set of environment variables that can override the settings in the configuration file. These variables are documented below.

Note

Environment variables have higher precedence than the configuration file. If a setting is defined in both the configuration file and an environment variable, the value from the environment variable will be used.

class idf_component_tools.environment.ComponentManagerEnvVariables

Component Manager settings.

Warning

For environment variable aliases, the first alias is the recommended one. Any other listed aliases are also supported, but deprecated and will raise a UserDeprecationWarning if they are set in the environment. They may be removed in the future.

attribute IDF_COMPONENT_API_TIMEOUT: float | None = None
Timeout for API requests to the Component Registry in seconds.
If not set, the default timeout of the HTTP client will be used.

Aliases:

  • IDF_COMPONENT_API_TIMEOUT

  • IDF_COMPONENT_SERVICE_TIMEOUT (deprecated)

attribute IDF_COMPONENT_API_TOKEN: str | None = None

API token to access the Component Registry.

attribute IDF_COMPONENT_CACHE_HTTP_REQUESTS: bool = True
Cache HTTP requests to the Component Registry during runtime.
Set 0 to disable.
attribute IDF_COMPONENT_CACHE_PATH: str | None = None
Cache directory for Component Manager.
Default: Depends on OS
attribute IDF_COMPONENT_CHECK_NEW_VERSION: bool = True

Check for new versions of components.

attribute IDF_COMPONENT_DEBUG_MODE: bool = False

Enable debug mode.

attribute IDF_COMPONENT_KNOWN_TARGETS: str | None = None

Targets that are known to the Component Manager.

Aliases:

  • IDF_COMPONENT_KNOWN_TARGETS

  • IDF_COMPONENT_MANAGER_KNOWN_TARGETS (deprecated)

attribute IDF_COMPONENT_NO_COLORS: bool = False

Disable colored output.

attribute IDF_COMPONENT_NO_HINTS: bool = False

Disable hints in the output.

attribute IDF_COMPONENT_OVERWRITE_MANAGED_COMPONENTS: bool = False
Overwrite files in the managed_components directory,
even if they have been modified by the user.
attribute IDF_COMPONENT_PROFILE: str | None = None
Profile in the config file to use.
Default: default

Aliases:

  • IDF_COMPONENT_PROFILE

  • IDF_COMPONENT_REGISTRY_PROFILE (deprecated)

  • IDF_COMPONENT_SERVICE_PROFILE (deprecated)

attribute IDF_COMPONENT_REGISTRY_URL: str | None = None
URL of the default Component Registry.
Default: https://components.espressif.com/

Aliases:

  • IDF_COMPONENT_REGISTRY_URL

  • DEFAULT_COMPONENT_SERVICE_URL (deprecated)

attribute IDF_COMPONENT_STORAGE_URL: str | None = None
URL of the default file storage server.
Default: https://components-file.espressif.com/
attribute IDF_COMPONENT_STRICT_CHECKSUM: bool = False
Validate checksums strictly.
If set to 1, checksum of each file will be compared to the expected value.
attribute IDF_COMPONENT_SUPPRESS_UNKNOWN_FILE_WARNINGS: bool = False

Ignore unknown files in managed_components directory.

Aliases:

  • IDF_COMPONENT_SUPPRESS_UNKNOWN_FILE_WARNINGS

  • IGNORE_UNKNOWN_FILES_FOR_MANAGED_COMPONENTS (deprecated)

attribute IDF_COMPONENT_VERIFY_SSL: bool | str = True
Verify SSL certificates when making requests to the Component Registry.
Set 0 to disable or provide a CA bundle path.
attribute IDF_COMPONENT_VERSION_PROCESS_TIMEOUT: int = 300

Timeout for processing version jobs in seconds.

Aliases:

  • IDF_COMPONENT_VERSION_PROCESS_TIMEOUT

  • COMPONENT_MANAGER_JOB_TIMEOUT (deprecated)