garaga
  • Garaga documentation
  • Installation
    • Python package
    • Rust Crate
    • Npm package
  • Developer setup & guides
    • Working with auto-generated Cairo Code
    • garaga-rs crate
      • Rust -> Python bindings
      • Rust -> Wasm bidings
  • Using garaga libraries in your Cairo project
    • ECDSA & Schnorr Signatures
    • Hashing functions
  • Deploy your own SNARK verifier on Starknet
    • Groth16
      • Generate and deploy your verifier contract
      • Generating calldata from a proof and using your deployed contract
        • Using Python/Garaga CLI
        • Using Rust
        • Using Typescript
    • Noir
  • Maintained Smart Contracts
    • RiscZero
    • SP1
    • Drand
  • Support
  • Updating these docs
Powered by GitBook
On this page
  • Install the latest released version of the CLI
  • Install a specific version or from a specific commit / from source
  • Installation troubleshooting

Was this helpful?

  1. Installation

Python package

PreviousInstallationNextRust Crate

Last updated 17 days ago

Was this helpful?

Install the latest released version of the CLI

PyPi link :

The easiest way to install Garaga is via pip, which will fetch and install the pre-built binary wheels for your platform.

  1. Open your terminal or command prompt.

  2. (Optional) If you're using a , simply activate your venv.

  3. Run the following command to install latest release version:

    pip install garaga
  4. Once the package is successfully installed, the CLI will be accessible via the command line:

    garaga

Note that the current Garaga distribution does require Python 3.10. One can use a Python Version Manager, such as , to conveniently install the proper Python runtime.

Please, ensure that the directory containing Python's executable files is included in your system's PATH environment variable. If you're using a venv, the necessary paths are automatically managed, so simply activate your venv before running the CLI.

If your Python 3.10 installation is not supported by one of the pre-built binary wheels, pip will attempt to install Garaga from its source distribution. In that case, please make sure to have and available.

Install a specific version or from a specific commit / from source

To install a specific version, use :

pip install --force-reinstall garaga==0.15.5
pip install git+https://github.com/keep-starknet-strange/garaga.git@COMMIT_HASH

Make sure the dependency on the Garaga Cairo library in Scarb.toml is at the same commit to ensure tooling are in sync.

Installation troubleshooting

You might have some dependencies issues on Linux or MacOs related to some packages that uses C code.

To install a version at specific commit, pick a commit hash from the and use :

Refer to the installations notes of Starknet.py to fix those issues.

https://pypi.org/project/garaga/
virtual environment (venv)
pyenv
Rust installed
github history
https://starknetpy.readthedocs.io/en/latest/installation.html