Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arcium.com/llms.txt

Use this file to discover all available pages before exploring further.

The arcup version manager enables easy installation and management of the Arcium Networks’ tooling suite, consisting of the Arcium CLI binary and the Arx Node Docker image. 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, 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 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 image for the Arx Node
You can also install older versions using the install command (and specifying a version), as well as removing installed versions with the uninstall command, and switching between already installed versions using the use command. See the Available Commands section below for full 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 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.4.5
  • Arx Node: 0.4.15
If a breaking change is made to the CLI (e.g. increment to 0.6.3), the MINOR version number of Nodes is also incremented (so both would become 0.6.3). However, if only a (non-breaking) PATCH upgrade is made to tooling, then tooling would increment to 0.6.3 and node would remain unchanged.

​
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