CLI Reference
Complete command-line reference for ryusim compile, coverage, and more.
Compilation
| Command / Flag |
Description |
ryusim compile <file> --top <mod> |
Compile SystemVerilog to simulation binary |
--coverage |
Enable all coverage types |
--coverage-line |
Line coverage only |
--coverage-branch |
Branch coverage only |
--coverage-toggle |
Toggle coverage only |
--coverage-file=<path> |
Custom coverage output file |
--trace-vcd |
Enable VCD waveform output |
--trace-fst |
Enable FST waveform output |
--broker-url <URL> |
Override the default IEEE 1735 broker endpoint (default: https://broker.seiraiyu.com/api/v1) |
Coverage
| Command |
Description |
ryusim coverage merge -o <out> ... |
Merge coverage from multiple runs |
Environment Variables
| Variable |
Description |
RYUSIM_API_KEY |
Optional. Authenticated broker requests get higher rate limits. Not required for encrypted IP — the broker accepts unauthenticated requests. |
RYUSIM_BROKER_URL |
Override the default broker endpoint. Same effect as --broker-url. The command-line flag takes precedence if both are set. |