Doc is incorrect in basic-commands.html : read_flash parameter (ESPTOOL-1314)

[gmeader]

Operating System

all

Esptool Version

all

Python Version

all

Chip Description

all

Device Description

No response

Hardware Configuration

No response

How is Esptool Run

n/A

Full Esptool Command Line that Was Run

No response

Esptool Output

More Information

in the basic-commands.html documentation file, the read_flash parameter to esptool has an underscore, not a hyphen

Other Steps to Reproduce

No response

I Have Read the Troubleshooting Guide

• I confirm I have read the troubleshooting guide.

[github-actions]

Hi @gmeader! Please be aware that (1) the following suggestions are generated by a bot and haven't been fact-checked by Espressif Systems, (2) burning eFuses and enabling security features are irreversible operations and can damage your ESP32 device. We hope that this message will help you until an Espressif Engineer looks at your issue.

---

Thanks for raising this! This is actually expected and intentional behavior as of esptool v5.

In esptool v5, all commands and options were renamed to use - (hyphens) instead of _ (underscores) as separators. So read_flash is now officially read-flash, and the documentation has been updated to reflect this. [v5 Migration Guide]

The current documentation at basic-commands.html correctly shows read-flash (with a hyphen):

esptool -p PORT -b 460800 read-flash 0 0x200000 flash_contents.bin

[Basic Commands – ESP32; Basic Commands – ESP8266]

The old underscore form (read_flash) is deprecated — it still works for now but will print a deprecation warning, and will be removed in the next major release. [v5 Migration Guide]

If you are seeing read_flash (with an underscore) in the documentation, you may be looking at an older version of the docs (pre-v5). Please make sure you are viewing the latest documentation. If the issue persists on the latest docs, it would be helpful to share the exact URL where you see the underscore form.

[radimkarnis]

Hello @gmeader,

I don't see read_flash with an underscore anywhere in the esptool documentation on master. Are you sure you are not looking at the v4 docs?

[radimkarnis]

Closing this issue.