cairo-args-runner is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install cairo-args-runner

It will make the cairo-args-runner command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall cairo-args-runner uninstalls.

Adding `cairo_args_runner` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add cairo-args-runner

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

cairo-args-runner = "2.0.1"

The cairo_args_runner library will be automatically available globally. Read the cairo_args_runner library documentation.

Back to the crate overview.

Readme

Cairo Args Runner

Overview

Cairo Args Runner is a streamlined utility for executing Cairo 1 programs with command-line arguments. It enhances the user experience by enabling direct argument specification in the command line, thus simplifying the execution of Cairo programs.

How to Use

Basic Usage

To use Cairo Args Runner, you need to:

Navigate to the target directory of your Cairo program.
Build the program using scarb build.
Run the program with the desired arguments.

Crate Installation via Cargo

You can also install this crate directly using the cargo install command. To do this, run the following command in your terminal:

cargo install cairo-args-runner

Example

Run a main function from the complex package located in examples/complex, passing [[1, 2, 4, 8, 16], [1, 2, 3, 4, 5, 6]] as the argument:

echo "[[1, 2, 4, 8, 16], [1, 2, 3, 4, 5, 6]]" | cargo run --release -- target/dev/complex.sierra.json

Additional Examples

Here are more examples for running different Cairo programs:

Fibonacci Sequence Example

echo "[10]" | cargo run --release -- target/dev/fib.sierra.json

Structs Example

echo "[1, 2, 10, 5, 9, [1, 2, 3]]" | cargo run --release -- target/dev/structs.sierra.json

Summation Example

echo "[[1, 3, 9, 27]]" | cargo run --release -- target/dev/sum.sierra.json

These examples demonstrate the versatility and ease of using Cairo Args Runner for different types of Cairo 1 programs.

Installing the command-line executable

Adding cairo_args_runner library as a dependency

Adding `cairo_args_runner` library as a dependency