@@ -25,12 +25,25 @@ The CLI will start the simulation and display the serial output. It will automat
2525
2626You can use the following options to customize the CLI behavior:
2727
28- - ` --fail-text <text> ` - fail if the serial output contains the specified text
29- - ` --expect-text <text> ` - fail if the serial output does not contain the specified text
30- ' ` --interactive ` - Redirect stdin to the simulated serial port
31- - ` --serial-log-file <filename> ` - save the serial output to the specified file
32- - ` --scenario <path> ` - path to an [ automation scenario] ( ./automation-scenarios ) file
33- - ` --timeout <milliseconds> ` - how long to wait for the simulation to finish (default: 30000)
34- - ` --timeout-exit-code <code> ` - exit code to use when the simulation times out (default: 42)
35- - ` --quiet ` - do not print version information and status messages
36- - ` --help ` - print help message
28+ ### Configuration
29+
30+ - ` --elf <path> ` - ELF file to simulate (default: read from wokwi.toml)
31+ - ` --diagram-file <path> ` - Path to the diagram.json file, relative to project root (default: diagram.json)
32+ - ` --interactive ` - Redirect stdin to the simulated serial port
33+ - ` --serial-log-file <path> ` - Save the serial monitor output to the given file
34+ - ` --timeout <number> ` - Timeout in simulation milliseconds (default: 30000)
35+ - ` --timeout-exit-code <number> ` - Process exit code when timeout is reached (default: 42)
36+
37+ ### Automation
38+
39+ - ` --expect-text <string> ` - Expect the given text in the output
40+ - ` --fail-text <string> ` - Fail if the given text is found in the output
41+ - ` --scenario <path> ` - Path to an [ automation scenario] ( ./automation-scenarios ) file, relative to project root
42+ - ` --screenshot-part <string> ` - Take a screenshot of the given part id (from diagram.json)
43+ - ` --screenshot-time <number> ` - Time in simulation milliseconds to take the screenshot
44+ - ` --screenshot-file <string> ` - File name to save the screenshot to (default: screenshot.png)
45+
46+ ### General
47+
48+ - ` --help ` , ` -h ` - Prints help information and exit
49+ - ` --quiet ` , ` -q ` - Quiet: do not print version or status messages
0 commit comments