# Python package

## Install the latest released version of the CLI

{% hint style="info" %}
PyPi link : <https://pypi.org/project/garaga/>
{% endhint %}

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)](https://docs.python.org/3/library/venv.html), simply activate your venv.
3. Run the following command to install latest release version:

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

   ```bash
   garaga
   ```

{% hint style="info" %}
**Garaga supports Python 3.10 through 3.14.** If you need to install a specific Python version, you can use [uv](https://docs.astral.sh/uv/):

```bash
uv python install 3.14  # or 3.13, 3.12, 3.11, 3.10
```

{% endhint %}

{% hint style="info" %}
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.
{% endhint %}

{% hint style="info" %}
If your Python 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](https://www.rust-lang.org/tools/install) and available.
{% endhint %}

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

To install a specific version, use :

```bash
pip install --force-reinstall garaga==1.1.0

```

To install a version at specific commit, pick a commit hash from the [github history](https://github.com/keep-starknet-strange/garaga/commits/main/) and use :

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

{% hint style="warning" %}
**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.1.0"` or the same git tag)
* If using Rust/npm SDKs, use the same version for those as well

See the [main documentation](/garaga/readme.md#version-compatibility) for details on why version matching matters.
{% endhint %}

## 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://garaga.gitbook.io/garaga/installation/python-package.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.