Arcup version manager

The arcup version manager installs and manages the Arcium tooling suite, including the Arcium CLI binary and the Arx node Docker image. Use it to install the current release, switch between installed versions, and update components when new releases are available. The Quick start section below covers basic arcup onboarding. For the full toolchain setup, see the installation overview. For component compatibility rules, see Inter-component versioning.

Quick start

First, check whether you already have a manually installed CLI or Arx node image:

command -v arcium || true
docker image ls "arcium/*"

If you no longer need those old installs, remove the specific binary or Docker image before using arcup. Then verify the old CLI is gone or ready to be replaced:

arcium --version
docker image ls "arcium/*"

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

arcup install # Installs the latest releases of the Arcium components

Now verify that everything is installed correctly:

arcium --version # Shows the latest CLI version
arcup version # Shows the currently installed Arcium component versions
docker images # Lists the image for the Arx node

You can also install older versions with arcup install <version>, remove installed versions with arcup uninstall, and switch between installed versions with arcup use. See Available commands for details.

arcium and arcup may print a one-line update banner. Set ARCIUM_NO_UPDATE_CHECK=1 to suppress it in scripts; CI and non-TTY runs are silent automatically.

Inter-component versioning

Arcium publishes the CLI and Arx node image as a coordinated release. arcup install <version> installs the matching CLI and image for that release, and arcup update updates both to the latest coordinated release. Use the same Arcium release across the CLI, Rust crates, TypeScript packages, and Arx node image. Mixed versions might work, but they are not tested or guaranteed. See Versioning and compatibility for compatibility across releases and the supported upgrade paths.

Available commands

install    Install the latest (or a specific) version of Arcium components (Arx node and CLI)
update     Update all Arcium components (Arx node and CLI) to the latest version
list       List all installed versions
version    Show currently active version
use        Switch to using a specific installed version
uninstall  Remove a specific version (alias: rm)
self       Manage arcup itself (update, uninstall)
help       Print this message or the help of the given subcommand(s)

Self management

The self subcommand allows you to manage arcup itself:

# Update arcup to the latest version
arcup self update

# Uninstall arcup and all Arcium components
arcup self uninstall

# Uninstall but keep Docker images
arcup self uninstall --keep-docker

# Skip confirmation prompt
arcup self uninstall --force

# Preview what would be removed (dry run)
arcup self uninstall --dry-run