Python package

Install the latest released version of the CLI

PyPi link : https://pypi.org/project/garaga/

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 virtual environment (venv), 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

Garaga requires Python 3.10.x specifically (not 3.11 or higher). Use a Python Version Manager like pyenv to install the correct version:

pyenv install 3.10
pyenv local 3.10

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 Rust installed and available.

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

To install a specific version, use :

pip install --force-reinstall garaga==1.0.1

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

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

Version Compatibility: When installing from a specific commit, ensure all Garaga components match:

• The garaga Cairo dependency in Scarb.toml should use the same version (e.g., garaga = "1.0.1" or the same git tag)

• If using Rust/npm SDKs, use the same version for those as well

See the main documentation for details on why version matching matters.

Installation troubleshooting

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

Refer to the installations notes of Starknet.py https://starknetpy.readthedocs.io/en/latest/installation.html to fix those issues.