esp-idf-diag
Diagnostic tool for ESP-IDF
Decision gist · record as of 2026-08-14
Yes. This is a lightweight, actively maintained diagnostic utility with no known vulnerabilities and permissive licensing. Install it if you develop with ESP-IDF and want to streamline bug reporting or troubleshooting. The low install friction and minimal dependencies make it a practical addition to any ESP-IDF workflow.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires an activated ESP-IDF environment to run the create command.
- Low install friction with a pure-Python wheel and only two runtime dependencies (PyYAML and rich).
- Active maintenance with a recent release and no known vulnerabilities.
License · maintenance · safety
permissive license (permissive) — Licensed under Apache Software License (permissive), which allows commercial and private use with minimal restrictions.
last release 2025-06-13 (427 days) · last repo commit 2026-06-08 · 2 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 410,476 downloads/mo, #6,864 on PyPI
Alternatives
Verify before relying
$ pip install esp-idf-diag
$ esp-idf-diag create
$ esp-idf-diag zip diag-UUID- Whether custom recipe YAML files can extend the default data collection beyond what is built-in.
- Performance characteristics when collecting diagnostics from large or complex ESP-IDF projects.
What it is and what it does
esp-idf-diag is a command-line diagnostic tool for the Espressif IoT Development Framework. It gathers information about the ESP-IDF environment, system configuration, and the current ESP-IDF project, organizing the collected data into a report directory. The tool is designed to help developers troubleshoot problems by automating the collection of relevant diagnostic information.
Data collection is managed through YAML-based recipes that specify which commands to run and capture. The tool includes automatic redaction of sensitive information (passwords, tokens in URLs) guided by a configurable purge file in YAML format. Once a report is generated, it can be compressed into a zip archive for easy sharing with maintainers or in GitHub issues. The tool supports Python 3.7 through 3.13 and runs on macOS, Windows, and POSIX systems.
Use it for
- Generate a diagnostic report when encountering build or runtime issues in an ESP-IDF project to share with the Espressif team.
- Collect system and environment information automatically before filing a bug report on GitHub.
- Create a redacted snapshot of your ESP-IDF setup for troubleshooting without exposing credentials or private paths.
- Archive diagnostic data from multiple development machines to compare configurations and identify environment-specific problems.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a lightweight, actively maintained diagnostic utility with no known vulnerabilities and permissive licensing. Install it if you develop with ESP-IDF and want to streamline bug reporting or troubleshooting. The low install friction and minimal dependencies make it a practical addition to any ESP-IDF workflow.
Install
esp-idf-diag on PyPI
Before you install
Low install friction with a pure-Python wheel and only two runtime dependencies (PyYAML and rich). Active maintenance with a recent release and no known vulnerabilities.
Requires an activated ESP-IDF environment to run the create command.
License in practice
Licensed under Apache Software License (permissive), which allows commercial and private use with minimal restrictions.
Quickstart
$ pip install esp-idf-diag
$ esp-idf-diag create
$ esp-idf-diag zip diag-UUIDVerify before relying
- Whether custom recipe YAML files can extend the default data collection beyond what is built-in.
- Performance characteristics when collecting diagnostics from large or complex ESP-IDF projects.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesPyYAMLrich |
| Maintenance | Actively maintained 427 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 410,476 / month, #6,864 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleIntended Audience :: DevelopersLicense :: OSI Approved :: Apache Software LicenseNatural Language :: EnglishOperating System :: MacOS :: MacOS XOperating System :: Microsoft :: WindowsOperating System :: POSIXProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Software Development :: Embedded Systems |
Evidence: esp_idf_diag-0.2.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “esp-idf diagnostic tool”
- esp-idf-diagCollects ESP-IDF environment, system, and project information into a…
- esp-idf-kconfigProvides kconfig language support and IDE tooling for configuring…
- idf-component-managerAutomatically downloads and manages ESP-IDF component dependencies…
Give your agent the search over MCP, or paste the wish link into any chat.
More Embedded Systems packages
Provides Python abstractions and utilities for Controller Area Network (CAN) communication, supporting multiple hardware backends and message logging formats.
Install it if you need to communicate with CAN buses from Python.
Provides quaternion representation, manipulation, and rotation operations for 3D geometry and animation, with support for smooth interpolation between orientations.
Calculates CRC and checksum values from binary data using parametrized algorithms from the CRC catalogue, supporting dozens of standard CRC variants and additive/XOR checksums.
Install it if you need standard CRC calculations; avoid it only if you require active feature development or real-time performance guarantees.
esptool is a serial utility for flashing, provisioning, and interacting with Espressif microcontroller SoCs over a serial connection.
Install it if you develop or deploy firmware on Espressif SoCs.
Provides kconfig language support and IDE tooling for configuring Espressif ESP-IDF embedded projects, including configuration parsing, validation, and documentation generation.
pyOCD is a Python-based debugger and programmer for Arm Cortex-M microcontrollers that works with many debug probes across Linux, macOS, Windows, and FreeBSD.
See also esp-idf-monitor · esp-idf-size · esp-idf-panic-decoder · idf-component-manager · esp-idf-nvs-partition-gen · esp-coredump · idf-build-apps · pytest-embedded-idf