Reference¶
Every command, by group. Run idftool COMMAND --help for all of a command's
options. The options shared by every command are under
Global options and Write options.
| Command | Description |
|---|---|
| Discovery | |
devices |
List serial ports and their USB adapters (alias ports) |
| Firmware | |
factory |
Flash an app to the factory partition |
ota |
Push an app to the next OTA slot and switch to it |
get-boot |
Show the currently-active OTA slot |
set-boot |
Force the next boot to a specific OTA partition |
clear-boot |
Erase otadata and let the bootloader fall back |
app-info |
Print the app description from an application binary |
| Partition I/O | |
read |
Read a partition (or slice) into a file |
write |
Write one or more files to named partitions |
erase |
Erase a partition (or slice) |
view |
Pretty-print a partition's contents |
| Images | |
create-image |
Merge partition binaries into a single flash image |
dump-image |
Dump the entire flash to an image file |
write-image |
Write a full flash image to the device |
print-image |
Print partition table and app info from a flash image |
| Bundles | |
create-bundle |
Pack partition images into a ZIP bundle |
dump-bundle |
Pack every partition from the device into a ZIP |
write-bundle |
Flash a bundle ZIP |
print-bundle |
Print what a bundle ZIP holds and what flashing it does |
| Partition table | |
print-table |
Print a partition table from a file or the device (alias list) |
create-table |
Convert a partition table between CSV and binary |
dump-table |
Read the partition table from the device into a file |
write-table |
Flash a partition table from a CSV or binary file |
| NVS | |
create-nvs |
Generate an NVS partition image from a CSV file |
write-nvs |
Generate an NVS image from CSV and flash it |
print-nvs |
List the contents of an NVS partition or image |
read-nvs |
Read an NVS partition from the device into a CSV |
extract-nvs |
Extract an NVS image file into a CSV |
get-nvs |
Print the value of one or more keys |
set-nvs |
Set or delete keys in an NVS partition or image |
| Filesystems | |
create-fs |
Build a filesystem image from a directory |
write-fs |
Build a filesystem image from a directory and flash it |
read-fs |
Read a filesystem partition and extract it to a directory |
extract-fs |
Extract a filesystem image file to a directory |
print-fs |
List the contents of a filesystem partition or image |
| Misc | |
enter-bootloader |
Drop the chip into ROM bootloader mode |
Tools¶
Espressif's tools, run on the selected device.