Octelium
Documentation

CLI

Cordium comes with the cordium CLI to run, manage Workspaces and run terminals and also manage other resources such as Spaces, Secrets, etc... and it is currently supported for Linux, MacOS and Windows for both x86_64/amd64 and arm64 architectures. Furthermore, it's recommended to use the octelium CLI as it is useful to connect to the underlying Octelium Cluster, which is useful for commands such as cordium ssh and cordium cp.

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 binary only curl -fsSL https://octelium.com/install-cordium.sh | bash # Octelium binaries (RECOMMENDED) curl -fsSL https://octelium.com/install.sh | bash

For Windows in Powershell

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

Container

You can pull the cordium image to be used for any container environment as follows:

docker pull ghcr.io/octelium/cordium

Homebrew

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

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

Build From Source

You can build the CLI tools from source code as follows:

git clone https://github.com/octelium/cordium cd octelium make build-cli

CLI Upgrade

You can also check whether there is a new latest version available for your Octelium clients as follows:

cordium version --check # OR cordium version --check