CLI - Cordium Docs

Cordium comes with the cordium CLI to run, manage and access Workspaces as well as to manage other resources such as Spaces, Templates, Secrets, Volumes and snapshots. It is currently supported for Linux, macOS and Windows for both x86_64/amd64 and arm64 architectures.

We also recommend installing the Octelium CLIs (i.e. octelium, octeliumctl and octops). The octelium CLI is used to log in to the Cluster and to connect to it, which is required by the SSH-based commands such as cordium ssh and cordium cp, while octeliumctl is used to manage the Octelium resources such as Users, Services and Policies.

note

Read in detail on how to use the cordium CLI here.

Using Shell Script

You can directly download and install pre-compiled binaries as follows:

For Linux and macOS:

# Cordium CLI
curl -fsSL https://octelium.com/install-cordium.sh | bash
# Octelium CLIs (RECOMMENDED)
curl -fsSL https://octelium.com/install.sh | bash

For Windows in PowerShell:

# Cordium CLI
iwr https://octelium.com/install-cordium.ps1 -useb | iex
# Octelium CLIs (RECOMMENDED)
iwr https://octelium.com/install.ps1 -useb | iex

Homebrew

You can also install the CLIs via Homebrew in macOS and Linux as follows:

# Cordium CLI
brew install octelium/tap/cordium
# Octelium CLIs (RECOMMENDED)
brew install octelium/tap/octelium

Container

You can pull the cordium container image to be used in any container environment (e.g. CI/CD pipelines and Kubernetes jobs) as follows:

docker pull ghcr.io/octelium/cordium

Since containers are typically non-interactive environments, you will want to authenticate via an authentication token Credential or an OIDC assertion of a WORKLOAD User (read more here). Here is an example:

docker run --rm \
  -e OCTELIUM_DOMAIN=example.com \
  -e OCTELIUM_AUTH_TOKEN=<AUTHENTICATION_TOKEN> \
  ghcr.io/octelium/cordium get workspaces

Inside Workspaces

You don't need to install anything inside your Workspaces. The cordium, octelium and octeliumctl binaries are automatically mounted into every Workspace and they are already authenticated as the Workspace's owner through the Workspace's own Session (read more here).

Build From Source

You can build the CLI from source code using Go as follows:

git clone https://github.com/octelium/cordium
cd cordium
make build-cli
# The binary is now available at ./bin/cordium

CLI Upgrade

You can check whether a newer release of the cordium CLI is available as follows:

cordium version --check

You can upgrade the CLI by simply re-running the installation method you used above.