Arcup Version Manager

The arcup version manager enables easy installation and management of the Arcium Networks' tooling suite, consisting of the Arcium CLI binary, the Arx Node Docker image, the Arcium Callback Server Docker image, and the Postgres Docker image (needed to run the Callback Server). With a single command you can install all of the necessary tools, as well as update all of them when there are new releases.

The Quick Start section below takes you through basic arcup onboarding, however you can find more detailed installation instructions here. Also, see the Versioning section below for details on how versioning is handled between the different components of the Arcium Network.

Quick Start

First, delete any local versions of the CLI, Arx Node (Docker) or Callback Server (Docker) that you may currently have installed on your machine (if you don't have any currently installed, you can skip this step):

rm $HOME/.cargo/bin/arcium
docker images | grep "arcium-hq" | awk '{print $1":"$2}' | xargs docker rmi -f

Verify that you do not have any versions of the CLI, Arx Node (Docker) or Callback Server (Docker) installed on your machine now:

arcium --version # Should return "No such file or directory"
docker images # Should not show any arcium-related images

Next, install arcup on your machine by following these steps. Then run the arcup install command:

arcup install # Will install the latest releases of the Arcium components

Now verify that everything is installed correctly:

arcium --version # Should show the latest CLI version
arcup version # Shows the currently installed versions of all of the Arcium components
docker images # Should list the images for the Arx Node, Callback Server, and Postgres

You can also install older versions using the install command (and specifying a version), as well as deleting installed versions with the delete command, and switching between already installed versions using the use command. See the Available Commands section below for full details.

Inter-Component Versioning

The arcup version manager is based on semver (MAJOR.MINOR.PATCH). With arcup, the PATCH version number need not be in-sync across the different components, however the MAJOR.MINOR version number will always be in-sync across all of the Arcium components. As such, PATCH changes are always non-breaking with respect to the other Arcium components.

For example, if the current versions are:

• CLI: 0.2.4

• Nodes (Arx Node and Callback Server): 0.2.15

If a breaking change is made to the CLI (e.g. increment to 0.3.0), the MINOR version number of Nodes is also incremented (so both would become 0.3.0). However, if only a (non-breaking) PATCH upgrade is made to Tooling, then Tooling would increment to 0.2.5 and Nodes would remain unchanged.

Available Commands

install  Install the latest (or a specific) version of Arcium components (Arx Node, CLI, and Callback Server)
update   Update all Arcium components (Arx Node, CLI, and Callback Server) to the latest version
list     List all installed versions
version  Show currently active version
use      Switch to using a specific installed version
delete   Delete a specific version
help     Print this message or the help of the given subcommand(s)