CLI

octl is the CLI for the Platform Orchestrator.

Current CLI version: 2.1.1

Installation #

Install octl on Linux #

1. Download the latest release with the command

   • x64-86
   • ARM64

   curl -fLO https://github.com/stellwerk-labs/platform-orchestrator-cli/releases/download/v2.1.1/platform-orchestrator-cli_2.1.1_linux_amd64.tar.gz
   tar xvzf platform-orchestrator-cli_2.1.1_linux_amd64.tar.gz
   rm platform-orchestrator-cli_2.1.1_linux_amd64.tar.gz README.md
   

   curl -fLO https://github.com/stellwerk-labs/platform-orchestrator-cli/releases/download/v2.1.1/platform-orchestrator-cli_2.1.1_linux_arm64.tar.gz
   tar xvzf platform-orchestrator-cli_2.1.1_linux_arm64.tar.gz
   rm platform-orchestrator-cli_2.1.1_linux_arm64.tar.gz README.md
   

2. Install octl

   sudo install -o root -g root -m 0755 octl /usr/local/bin/octl
   

   

   Note

   If you do not have root access on the target system, you can still install octl to the ~/.local/bin directory:

   chmod +x octl
   mkdir -p ~/.local/bin
   mv ./octl ~/.local/bin/octl
   # and then append (or prepend) ~/.local/bin to $PATH
   

Install octl on macOS #

1. Download the latest release with the command

   • Intel
   • Apple Silicon

   curl -fLO https://github.com/stellwerk-labs/platform-orchestrator-cli/releases/download/v2.1.1/platform-orchestrator-cli_2.1.1_darwin_amd64.tar.gz
   tar xvzf platform-orchestrator-cli_2.1.1_darwin_amd64.tar.gz
   rm platform-orchestrator-cli_2.1.1_darwin_amd64.tar.gz README.md
   

   curl -fLO https://github.com/stellwerk-labs/platform-orchestrator-cli/releases/download/v2.1.1/platform-orchestrator-cli_2.1.1_darwin_arm64.tar.gz
   tar xvzf platform-orchestrator-cli_2.1.1_darwin_arm64.tar.gz
   rm platform-orchestrator-cli_2.1.1_darwin_arm64.tar.gz README.md
   

2. Install octl

   chmod +x ./octl
   sudo mv ./octl /usr/local/bin/octl
   sudo chown root: /usr/local/bin/octl
   

Install octl on Windows #

1. Download the latest release .

2. Decompress the zip file, and move the binary to your PATH.

Available as Docker Image #

octl is also published as a Docker image , which can be used like docker run --rm -it ghcr.io/stellwerk-labs/octl:2.1.1.

Validate your installation #

Run octl --version to ensure octl is in your path. Expected output, matching your installed version: octl version github.com/stellwerk-labs/platform-orchestrator-cli <version XX.YY.ZZ> <commit-hash> <commit-date>

CLI cheat sheet #

An overview of common and useful CLI commands is available in the CLI cheat sheet.

Authentication #

Once your installation administrator has created your user and organization, use the octl login command to authenticate the CLI against the configured API endpoint.

octl login

This obtains a short-lived authentication token which is written to the local config file.

Configuration #

octl will maintain a local configuration in a config file located at ~/.config/octl/config.yaml. Use the command octl config or the list below to see available configuration items.

Each configuration item can be overridden using an Environment Variable.

The command octl config show displays the effective configuration, taking any override into account.

Store a token, for example the token of a service user, from a file or from standard input, so that it does not end up in your shell history or the process list:

octl config set-token --token-file service-user.token
octl config set-token --token-file -    # paste the token, then press Ctrl-D

The input holds the token alone, and surrounding whitespace such as a final line break is ignored. A token given as an argument (octl config set-token <token>) still works, but octl prints a warning that it is visible in shell history and the process list.

Commands #

octl follows a hierarchical command structure generally adhering to this pattern:

octl <verb> <object> [additional classification]

E.g. to see the details of a particular Provider, use this command:

octl get provider <type> <id>

All available commands are listed and explained in the CLI online help. Use the -h or --help flag to see usage details on any command level, e.g.:

octl get provider -h