Cairo is a programming language for writing provable programs.
The Cairo documentation consists of two parts: "Hello Cairo" and "How Cairo Works?". Both parts can be found in https://cairo-lang.org/docs/.
We recommend starting from Setting up the environment.
You should be able to download the python package zip file directly from
github
and install it using pip
.
See Setting up the environment.
However, if you want to build it yourself, you can build it from the git repository. It is recommended to run the build inside a docker (as explained below), since it guarantees that all the dependencies are installed. Alternatively, you can try following the commands in the docker file.
Note: This section is relevant only if you wish to build the Cairo python-package yourself, rather than downloading it.
The root directory holds a dedicated Dockerfile, which automatically builds the package and runs the unit tests on a simulated Ubuntu 18.04 environment. You should have docker installed (see https://docs.docker.com/get-docker/).
Clone the repository and initialize the git submodules using:
> git clone [email protected]:starkware-libs/cairo-lang.git
> cd cairo-lang
Build the docker image:
> docker build --tag cairo .
If everything works, you should see
Successfully tagged cairo:latest
Once the docker image is built, you can fetch the python package zip file using:
> container_id=$(docker create cairo)
> docker cp ${container_id}:/app/cairo-lang-0.8.1.zip .
> docker rm -v ${container_id}