Skip to main content

List of Commands

tip

You can print the list of commands by running snarkvm --help

The Aleo private key, view key, and address will be printed to console. See concepts/accounts for more information.

snarkvm new​

To create a new package, run:

snarkvm new {$NAME}

Valid package names are snake_case: lowercase letters and numbers separated by underscore. This command will create a new directory with the given package name. The new package will have a directory structure as follows:

package-name/
├── program.json # Your program manifest
├── README.md # Your program description
└── main.leo # Your program file

snarkvm build​

info

This command is deprecated as of snarkVM v0.14.5. It will be removed in a future release.

To compile your program and verify that it builds properly, run:

snarkvm build

To compile your program in offline mode run:

snarkvm build --offline

snarkvm run​

To run your Aleo program function run:

snarkvm run {$FUNCTION} {$INPUTS}

// Example
snarkvm run hello 2u32 3u32

To run your Aleo program function in offline mode run:

snarkvm run {$FUNCTION} {$INPUTS} --offline

To run your Aleo program function to a specified endpoint run:

snarkvm run {$FUNCTION} {$INPUTS} --endpoint {$ENDPOINT}

snarkvm execute​

To execute your Aleo program function run:

snarkvm execute {$FUNCTION} {$INPUTS}

// Example
snarkvm run hello 2u32 3u32

To execute your Aleo program function in offline mode run:

snarkvm execute {$FUNCTION} {$INPUTS} --offline

To execute your Aleo program function to a specified endpoint run:

snarkvm execute {$FUNCTION} {$INPUTS} --endpoint {$ENDPOINT}

snarkvm clean​

To clean the Aleo package build directory run:

snarkvm clean

snarkvm update​

To update snarkVM to the latest version run:

snarkvm update

To list the available versions of Aleo run:

snarkvm update --list

To update snarkVM and suppress outputs to terminal run:

snarkvm update --quiet