Installing the CLI tools

Octelium comes with 3 CLIs and all of which are currently supported for Linux, macOS and Windows for both x86_64/amd64 and arm64 architectures.

octelium Used by all Users to connect to the Cluster and access its Services.
octeliumctl Used by the Cluster managers to manage the Cluster's resources.
octops Used to install, upgrade and uninstall Clusters, as well as other functionalities such as setting the TLS certificates used by the Cluster.

Using Shell Script

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

For Linux and macOS

curl -fsSL https://octelium.com/install.sh | bash

For Windows in Powershell

iwr https://octelium.com/install.ps1 -useb | iex

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

docker pull ghcr.io/octelium/octelium

note

See how to connect to a Cluster via the container here

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

brew install octelium/tap/octelium

You can also install the CLIs via Chocolatey in Windows as follows:

choco install octelium

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

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

Now you will find the 3 binaries octelium, octeliumctl and octops in the directory bin inside your git repo root directory.

You can read more about how to connect with octelium containers here.

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

octelium version --check
# OR
octeliumctl version --check