Install Supra CLI with Docker

Installation of the Supra CLI using Docker.

Prerequisites

• Install Docker (Windows, Mac, Linux)

• Follow Docker post-installation steps (Linux only, If needed)

• Review the Docker Cheat Sheet for useful commands

The installation process of Docker is straight forward and requires no additional configuration. The only requirement to proceed is to ensure the Docker Daemon is running. If you installed Docker Engine, opening the program will start the daemon.

Install and Setup the CLI

1

Get the latest docker compose file

Open your terminal and cd to the directory on your machine where you wish to setup the CLI. For convenience, we recommend creating a directory named supra within your documents directory. However, this is entirely arbitrary and there will be no repercussions for choosing differently.

Grab the latest compose.yaml file with the following command. If you want to inspect the file first, you can view it here.

curl --output compose.yaml "https://raw.githubusercontent.com/Entropy-Foundation/supra-dev-hub/refs/heads/main/Scripts/compose.yaml"

compose.yaml is a YAML configuration file that contains all of the parameters needed to configure the container. The file contains the link to the Docker Image containing the Supra CLI binary, bind mount paths to enable file sharing between the host machine/container, and more. You can read more about how compose works here.

2

Start the container

Within the directory containing the compose.yaml file, execute the following command:

docker compose up -d

Once executed, the supra_cli container will be created. If a supra_configs directory does not already exist within your current working directory, one will be created for you. You can confirm that the container is running by executing docker ps --all. This command will output all docker containers that exist on your machine, whether they are running or stopped.

The supra_configs directory will be bind mounted to the configs directory within the Docker container. Files within these directories will coexist between the host machine and the container. Generated key profiles, logs, and more can be found within these folders. This setup is defined within the compose.yaml file under the volumes section.

3

Enter the shell of the container

Docker containers are a form of virtualization that contain everything needed to run the desired application. This makes the distribution and setup of the Supra CLI extremely convenient. There are many useful actions that can be taken with this setup, but for now it is important to recognize that the CLI itself is executed within the container, not on your host machine.

To interact with the Supra CLI, we must enter the shell of the container. This will allow us to execute commands within the container from our host machine.

Execute the following command:

docker exec -it supra_cli /bin/bash 

Once inside, execute the ls command to gain a simple understanding of the file system. The displayed configs directory is bind mounted to the supra_configs directory on your host machine. These directories are shared/linked between your host machine and the container.

Note: "supra" is the CLI binary within the container. The compose file automatically setup the alias to interact with the binary using the "supra" command.

4

Execute the supra command

Within the shell of the container, CLI commands operate in the same manner as you would expect on your host machine. For example, executing commands such as supra move tool init will initialize the new module within your current working directory. You may view all available arguments of any command by passing the --help argument.

Example: supra move tool init --help