Add docs on CLI
MODIFY
docs/README.md
docs/README.md
@@ -10,4 +10,5 @@ Is this your first time using Ripes? check out the [introduction/tutorial](intro
- [Adapting Compiler Explorer generated RISC-V assembly code](compiler_explorer.md)
- [Memory-mapped IO in Ripes](mmio.md)
- [Supported ecalls](ecalls.md)
+- [Command-line interface](cli.md)
- [Release notes](release_notes.md)

ADD
docs/cli.md
+# Command-line Interface
+
+Ripes v.2.2.5 adds support for a command line interface. Through this, programs can be assembled/compiled and simulated on any of the available processor models.
+
+An example execution could be:
+```sh
+./Ripes
+ --mode cli \ # Enable command line interface
+ --src foo.s \ # Input file
+ -t asm \ # Input file type
+ --proc "RV32_5S" \ # Processor model
+ --isaexts M,C \ # ISA extensions to enable in the assembler/processor
+ --ipc \ # show IPC
+ --cycles \ # show # of cycles executed
+ --pipeline # Show pipeline state during execution
+```
+
+## Options
+
+See `./Ripes --help` for further information.
+
+| *Flag* | *Description* |
+| ---- | ----------- |
+| --mode <mode> | Ripes mode Options: `(gui, cli)` |
+| --src <src> | Source file |
+| -t <type> | Source type. Options: `(c, asm, bin)` |
+| --proc <proc> | Processor model (see `./Ripes --help` for options). |
+| --isaexts <isaexts> | ISA extensions to enable (comma separated). |
+| --timeout <timeout> | Simulation timeout in milliseconds. If simulation does not finish within the specified time, it will be aborted. |
+| -v | Verbose output and runtime status information. |
+| --output <output> | Telemetry output file. If not set, telemetry is printed to stdout. |
+| --json | Report JSON-formatted telemetry. |
+| --all | Enable all telemetry options. |
+| --cycles | Report cycles |
+| --iret | Report instructions retired |
+| --cpi | Report cycles per instruction (CPI) |
+| --ipc | Report instructions per cycle (IPC) |
+| --pipeline | Report pipeline state |
+| --regs | Report register values |
+| --runinfo | Report simulation information in output (processor configuration, input file, ...) |
+

MODIFY
docs/introduction.md
docs/introduction.md
@@ -150,27 +150,10 @@ Ripes includes memory mapped I/O allowing for interaction with various different
[here](mmio.md).
-## Command-line interface
-
-Ripes v.2.2.5 adds support for command-line execution. Through this, programs can be assembled, compiled, and loaded into the simulator, and simulated on any processor model in Ripes.
-An example execution could be:
-```sh
-./Ripes
- --mode cli \ # Enable command line interface
- --src foo.s \ # Input file
- -t asm \ # Input file type
- --proc "RV32_5S" \ # Processor model
- --isaexts M,C \ # ISA extensions to enable in the assembler/processor
- --ipc \ # show IPC
- --cycles \ # show # of cycles executed
- --pipeline # Show pipeline state during execution
-```
-
-See `./Ripes --help` for further information on using Ripes in command-line mode.
-
## Up Next...
This concludes the introduction to Ripes and its main features. Reading on, please refer to the following pages:
- [Cache simulation with Ripes](cache_sim.md)
- [Building and Executing C programs with Ripes](c_programming.md)
- [Adapting Compiler Explorer generated RISC-V assembly code](compiler_explorer.md)
- [Interacting with memory-mapped devices](mmio.md)
+- [Using the command line interface](cli.md)

Add docs on CLI