Skip to main content
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

The arcup version manager follows semver (MAJOR.MINOR.PATCH). Component patch versions do not need to stay in sync, but major and minor versions must match across Arcium components. Patch changes are therefore non-breaking with respect to the other Arcium components. For example, if the current versions are:
  • CLI: 0.4.5
  • Arx node: 0.4.15
If a breaking change is made to the CLI (incrementing it to 0.5.0), the MINOR version number of the Arx node is also incremented, so both become 0.5.0. However, if only a (non-breaking) PATCH upgrade is made to the CLI, the CLI increments to 0.4.6 and the Arx node remains at 0.4.15.

​
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