> ## 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.

# Arcup version manager

> Install and manage Arcium toolchain versions with arcup

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](#quick-start) section below covers basic `arcup` onboarding. For the full toolchain setup, see the [installation overview](/developers/installation). For component compatibility rules, see [Inter-component versioning](#inter-component-versioning).

## Quick start

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

```bash theme={null}
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:

```bash theme={null}
arcium --version
docker image ls "arcium/*"
```

Next, install `arcup` on your machine by following the [manual installation steps](/developers/installation#manual-installation). Then run the `arcup install` command:

```bash theme={null}
arcup install # Installs the latest releases of the Arcium components
```

Now verify that everything is installed correctly:

```bash theme={null}
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](#available-commands) for details.

<Note>
  `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.
</Note>

## 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](/developers/versioning) for compatibility across releases and the supported upgrade paths.

## Available commands

```bash theme={null}
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:

```bash theme={null}
# 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
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.