Installation

The primary requirements for building on Cartesi are the Cartesi CLI and Docker Desktop for your operating system of choice.

Cartesi CLI is an easy-to-use tool with which you can develop and deploy your dApps without getting lost in intricate commands and configurations of Docker and the node itself.

Docker is the required tool to distribute the Cartesi Rollups framework and its dependencies.

Install Docker Desktop

Docker Desktop is a must-have requirement that comes pre-configured with two necessary plugins for building dApps Cartesi:

• Docker Buildx
• Docker Compose

Follow the instructions here to install Docker Desktop for your operating system.

troubleshooting common errors

Error: Invalid image Architecture

Error: Invalid image Architecture: Expected riscv64

Solution:

1. Check if your Docker supports the RISCV platform by running:

   docker buildx ls

2. If you do not see linux/riscv64 in the platforms list, install QEMU by running:

   apt install qemu-user-static

Install Node.js

To download the latest version of Node.js, visit nodejs.org/en/download.

After downloading, run the installer and follow the instructions to complete the installation.

Verify the installation by running node -v, which will display the version of Node.js that was installed.

Install Cartesi CLI

deprecation notice

The Sunodo CLI has been deprecated. We recommend that all developers migrate their existing applications to the new Cartesi CLI tool as soon as possible.

macOS

Install Cartesi CLI with Homebrew:

brew install cartesi/tap/cartesi

Alternatively, you can use Node.js to install Cartesi CLI:

npm install -g @cartesi/cli

Linux

Install Cartesi CLI with Node.js:

npm install -g @cartesi/cli

Windows

1. Install WSL2 and Ubuntu from the Microsoft store

2. Install Cartesi CLI with Node.js

npm install -g @cartesi/cli

building on windows?

For a seamless development workflow on Windows, do not execute Docker commands within Powershell. Instead, open the latest Ubuntu terminal that you have installed and perform all coding and command execution within that Linux environment.

Cartesi CLI doctor is a diagnostic tool that declares whether your system is ready and set up for development.

$ cartesi doctor
✔ Your system is ready for cartesi.