Install Supra CLI with Docker

Installation of the Supra CLI using Docker.

Prerequisites

• Install Docker Engine or Docker Desktop

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

Install and Setup the CLI

1

Create a Workspace Directory

Execute the following command with your desired path to create a new directory named /supra_configs/move_workspace which will be used as your main workspace for the CLI.

Generated key profiles, initialized packages, and more can be found within the /supra_configs folder while the move_workspace sub-directory will serve as the primary location for all of your Move packages.

mkdir -p <YOUR_PATH>/supra_configs/move_workspace

2

Execute the Docker Run Command

The supra_configs directory will be bind mounted to the Docker container and accessible by the CLI/from within the container.

Replace <YOUR_PATH> in the following command with the path of your supra_configs folder. This command will pull the image and start the container.

docker run --name supra_cli -v <YOUR_PATH>:/supra/configs -e SUPRA_HOME=/supra/configs --net=host -itd asia-docker.pkg.dev/supra-devnet-misc/supra-testnet/validator-node:v6.3.0

You can view running containers with the command: docker ps

You can stop the running container with the command: docker stop supra_cli

3

Set Aliasing for the Supra CLI

As the CLI exists within the Docker container, we must execute our commands within the container. To make this easier, we can create an alias.

By setting an alias, you will be able to access the CLI from your device's native terminal without having to manually enter the container's shell.

Linux/Mac

Temporary Alias

A temporary alias will only exist for the current terminal session. You will have to execute this again at the start of each session.

In your terminal, execute the following command:

alias supra="docker exec -it supra_cli /supra/supra"

---

You are now able to access the CLI using the supra command.

Windows

Temporary Alias

A temporary alias will only exist for the current PowerShell session. You will have to execute this again at the start of each session.

In Windows PowerShell, execute the following command(s).

function supra_cli { docker exec -it supra_cli /supra/supra $args } & Set-Alias -Name supra -Value supra_cli

Permanent Alias

If you experience any issues, try running Windows PowerShell as adminstrator and repeating these steps.

To set a permanent alias, execute the following command from within PowerShell.

notepad $profile

If you are prompted with a message stating the file does not exist, select the option to create the file.

In notepad, add the following text to the file and save the file.

function supra_cli { 
docker exec -it supra_cli /supra/supra $args 
}
Set-Alias -Name supra -Value supra_cli

Restart your PowerShell session to finalize the setup of your permanent alias.

4

Execute the supra command