According to the documentation, the idf-monitor cannot be used normally. (IDFGH-16871)

[TinyuZhao]

Checklist

• Checked the issue tracker for similar issues to ensure this is not a duplicate
• Read the documentation to confirm the issue is not addressed there and your configuration is set correctly
• Tested with the latest version to ensure the issue hasn't been fixed

How often does this bug occurs?

always

Expected behavior

Use idf-monitor as normal

Actual behavior (suspected bug)

Unable to use idf-monitor normally

Error logs or terminal output

Steps to reproduce the behavior

Following the installation tutorial in the documentation, I am unable to install esp-idf-monitor successfully.

Using pip install esp-idf-monitor or uv pip install esp-idf-monitor, even after restarting the command line, the idf-monitor fails to function properly.

Project release version

1.8.0

System architecture

ARM 64-bit (Apple M1/M2, Raspberry Pi 4/5)

Operating system

MacOS

Operating system version

Sequoia 15.4.1

Shell

ZSH

Additional context

No response

[TinyuZhao]

By the way, I can confirm that my terminal has the virtual environment containing esp-idf-monitor enabled.

[dobairoland]

@TinyuZhao Please check again. The documentation suggests uv install and not uv pip install you've tried.

[peterdragun]

Please note that there hasn't a release since this idf-monitor alias was introduced, so this is still waiting to be released. There are one or two more features that we would like to include in the release, if possible. Without those, the release would be quite small.

[TinyuZhao]

@TinyuZhao Please check again. The documentation suggests uv install and not uv pip install you've tried.

Could it be a version difference?

[peterdragun]

The documentation suggests uv install and not uv pip install you've tried.

I believe the documentation in this case is missing the pip, and it should actually be uv pip install esp-idf-monitor. I am sorry for that. I will fix this. Thanks for pointing that out.