IDF Component Management Logo

Documentation

  • Getting Started
  • Use components
  • Publish components
  • Troubleshooting
  • Reference
IDF Component Management
  • IDF Component Manager and ESP Component Registry Documentation
  • View page source

IDF Component Manager and ESP Component Registry Documentation

This documentation covers the IDF Component Manager and the ESP Component Registry. The Component Manager integrates with ESP-IDF to download and manage components from the Registry, and it also provides the compote CLI for advanced workflows. The ESP Component Registry (components.espressif.com) is the central repository for ESP-IDF-compatible components.

Documentation

  • Getting Started
    • Where to go next
    • Checking the IDF Component Manager Version
  • Use components
    • How to Add a Dependency to an ESP-IDF Project
    • How to Update Dependencies
    • How to Configure the IDF Component Manager
    • How to Use Component Manager Offline
    • How to Create and Use Partial Mirror
    • Explanation of the Version Solver
  • Publish components
    • Tutorial to Package and Upload an ESP-IDF Component
    • How to Authenticate for Publishing
    • How to Upload a Component
    • How to Upload from GitHub Actions
    • How to Control Which Files are Uploaded
    • How to Package and Upload Examples
    • Explanation of Registry Namespaces and Roles
  • Troubleshooting
    • Getting help
    • FAQ
  • Reference
    • Compote CLI
    • idf_component_manager.yml Configuration File
    • idf_component.yml Manifest File
    • Dependencies.lock File
    • Versioning
    • ESP Component Registry Badge Endpoint
    • ESP Component Registry API
Next

© Copyright 2023-2025, Espressif Systems (Shanghai) Co., Ltd..

Built with Sphinx using a theme provided by Read the Docs.