Skip to content

Commit c6258f7

Browse files
jessebrahamjessebraham
committed
Update READMEs to reflect new command-line interface
1 parent 812749e commit c6258f7

File tree

2 files changed

+19
-138
lines changed

2 files changed

+19
-138
lines changed

‎cargo-espflash/README.md

+7-79
Original file line numberDiff line numberDiff line change
@@ -27,95 +27,23 @@ $ cargo binstall cargo-espflash
2727
## Usage
2828

2929
```text
30-
cargo-espflash 1.7.0
30+
cargo-espflash 2.0.0-dev
31+
Cargo subcommand for flashing Espressif devices over serial
3132
3233
USAGE:
33-
cargo espflash [OPTIONS] [SERIAL] [SUBCOMMAND]
34-
35-
ARGS:
36-
<SERIAL> Serial port connected to target device
34+
cargo espflash <SUBCOMMAND>
3735
3836
OPTIONS:
39-
--bin <BIN>
40-
Binary to build and flash
41-
42-
--bootloader <BOOTLOADER>
43-
Path to a binary (.bin) bootloader file
44-
45-
--erase-otadata
46-
Erase the OTADATA partition This is useful when using multiple OTA partitions and still
47-
wanting to be able to reflash via espflash
48-
49-
--example <EXAMPLE>
50-
Example to build and flash
51-
52-
-f, --flash-freq <FREQUENCY>
53-
Flash frequency [possible values: 12M, 15M, 16M, 20M, 24M, 26M, 30M, 40M, 48M, 60M, 80M]
54-
55-
--features <FEATURES>
56-
Comma delimited list of build features
57-
58-
--format <FORMAT>
59-
Image format to flash [possible values: bootloader, direct-boot]
60-
61-
--frozen
62-
Require Cargo.lock and cache are up to date
63-
64-
-h, --help
65-
Print help information
66-
67-
--locked
68-
Require Cargo.lock is up to date
69-
70-
-m, --flash-mode <MODE>
71-
Flash mode to use [possible values: QIO, QOUT, DIO, DOUT]
72-
73-
--monitor
74-
Open a serial monitor after flashing
75-
76-
--monitor-speed <MONITOR_SPEED>
77-
Baud rate at which to read console output
78-
79-
--package <PACKAGE>
80-
Specify a (binary) package within a workspace to be built
81-
82-
--partition-table <PARTITION_TABLE>
83-
Path to a CSV file containing partition table
84-
85-
--ram
86-
Load the application to RAM instead of Flash
87-
88-
--release
89-
Build the application using the release profile
90-
91-
-s, --flash-size <SIZE>
92-
Flash size of the target [possible values: 256KB, 512KB, 1MB, 2MB, 4MB, 8MB, 16MB, 32MB,
93-
64MB, 128MB]
94-
95-
--speed <SPEED>
96-
Baud rate at which to flash target device
97-
98-
--target <TARGET>
99-
Target to build for
100-
101-
--target-dir <TARGET_DIR>
102-
Directory for all generated artifacts
103-
104-
--use-stub
105-
Use RAM stub for loading
106-
107-
-V, --version
108-
Print version information
109-
110-
-Z <UNSTABLE>
111-
Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details
37+
-h, --help Print help information
38+
-V, --version Print version information
11239
11340
SUBCOMMANDS:
11441
board-info Display information about the connected board and exit without flashing
42+
flash Flash an application to a target device
11543
help Print this message or the help of the given subcommand(s)
44+
monitor Open the serial monitor without flashing
11645
partition-table Operations for partitions tables
11746
save-image Save the image to disk instead of flashing to device
118-
serial-monitor Open the serial monitor without flashing
11947
```
12048

12149
## Configuration

‎espflash/README.md

+12-59
Original file line numberDiff line numberDiff line change
@@ -23,71 +23,24 @@ $ cargo binstall espflash
2323
## Usage
2424

2525
```text
26-
espflash 1.7.0
26+
espflash 2.0.0-dev
27+
A command-line tool for flashing Espressif devices over serial
2728
2829
USAGE:
29-
espflash [OPTIONS] [ARGS] [SUBCOMMAND]
30-
31-
ARGS:
32-
<SERIAL> Serial port connected to target device
33-
<IMAGE> ELF image to flash
30+
espflash <SUBCOMMAND>
3431
3532
OPTIONS:
36-
--bootloader <BOOTLOADER>
37-
Path to a binary (.bin) bootloader file
38-
39-
--erase-otadata
40-
Erase the OTADATA partition This is useful when using multiple OTA partitions and still
41-
wanting to be able to reflash via espflash
42-
43-
-f, --flash-freq <FREQUENCY>
44-
Flash frequency [possible values: 12M, 15M, 16M, 20M, 24M, 26M, 30M, 40M, 48M, 60M, 80M]
45-
46-
--format <FORMAT>
47-
Image format to flash [possible values: bootloader, direct-boot]
48-
49-
-h, --help
50-
Print help information
51-
52-
--log-level <LOG_LEVEL>
53-
Log level [env: LOG_LEVEL=] [default: info]
54-
55-
-m, --flash-mode <MODE>
56-
Flash mode to use [possible values: QIO, QOUT, DIO, DOUT]
57-
58-
--monitor
59-
Open a serial monitor after flashing
60-
61-
--monitor-speed <MONITOR_SPEED>
62-
Baud rate at which to read console output
63-
64-
--partition-table <PARTITION_TABLE>
65-
Path to a CSV file containing partition table
66-
67-
--ram
68-
Load the application to RAM instead of Flash
69-
70-
-s, --flash-size <SIZE>
71-
Flash size of the target [possible values: 256KB, 512KB, 1MB, 2MB, 4MB, 8MB, 16MB, 32MB,
72-
64MB, 128MB]
73-
74-
--speed <SPEED>
75-
Baud rate at which to flash target device
76-
77-
--use-stub
78-
Use RAM stub for loading
79-
80-
-V, --version
81-
Print version information
33+
-h, --help Print help information
34+
-V, --version Print version information
8235
8336
SUBCOMMANDS:
84-
board-info Display information about the connected board and exit without
85-
flashing
86-
help Print this message or the help of the given subcommand(s)
87-
partition-table Operations for partitions tables
88-
save-image Save the image to disk instead of flashing to device
89-
serial-monitor Open the serial monitor without flashing
90-
write-bin-to-flash Writes a binary file to a specific address in the chip's flash
37+
board-info Display information about the connected board and exit without flashing
38+
flash Flash an application to a target device
39+
help Print this message or the help of the given subcommand(s)
40+
monitor Open the serial monitor without flashing
41+
partition-table Operations for partitions tables
42+
save-image Save the image to disk instead of flashing to device
43+
write-bin Writes a binary file to a specific address in the chip's flash
9144
```
9245

9346
## Configuration

0 commit comments

Comments
 (0)