Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add cli args description to readme #1386

Merged
merged 3 commits into from
Aug 17, 2023
Merged

Add cli args description to readme #1386

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7297bfe
Add cli args description to readme
fmoletta Aug 17, 2023
22bb97b
Merge branch 'main' into cli-args-readme
fmoletta Aug 17, 2023
190ecdd
use proof file
fmoletta Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,29 @@ cargo build --release

cairo-compile cairo_programs/abs_value_array.cairo --output cairo_programs/abs_value_array_compiled.json

target/release/cairo-vm-run cairo_programs/abs_value_array_compiled.json --layout all_cairo
target/release/cairo-vm-cli cairo_programs/abs_value_array_compiled.json --layout all_cairo
```

#### Other CLI arguments

The cairo-vm-cli supports the following optional arguments:

- `--trace_file <TRACE_FILE>`: Receives the name of a file and outputs the relocated trace into it

- `--memory_file <MEMORY_FILE>` : Receives the name of a file and outputs the relocated memory into it

- `--print_output` : Prints the program output

- `--proof_mode`: Runs the program in proof_mode

- `--secure_run`: Runs security checks after execution. Enabled by default when not in proof_mode

- `--air_public_input <AIR_PUBLIC_INPUT>`: Receives the name of a file and outputs the AIR public inputs into it. Can only be used if proof_mode is also enabled.

For example, to obtain the air public inputs from a fibonacci program run, we can run :

```bash
target/release/cairo-vm-cli cairo_programs/proof_programs/fibonacci.json --layout all_cairo --proof_mode --air_public_input fibonacci_public_input.json
```

### Using hints
Expand Down
Loading