Skip to main content
Tools for accessing the Orka service. CI/CD integrations for Orka.

​
Orka CLI

Visit the links below to download a version of the Orka CLI binary that matches your environment.
Starting with Orka 4.0, the CLI is named orka. On Orka 3.x, the CLI is orka3. Download the version that matches your cluster.
Complete the installation
  • On macOS, run the orka.pkg package (orka3.pkg for 3.x) and complete the installation. Installing the 4.0 package leaves the 3.x orka3 binary in place, so you can keep both if you manage Orka 3.6 and 4.0 clusters.
  • On Linux, unpack the archive and move the orka executable (orka3 for 3.x) to your PATH location (for example: /usr/local/bin). The file is already set as an executable.
  • On Windows, add the folder containing the downloaded executable to your Path system variable.
Using Homebrew? Run brew install --cask orka for the Orka 4.x CLI, or brew install --cask orka3 for Orka 3.6 LTS. The two casks are separate, so brew upgrade doesn’t move you from orka3 to orka, and you can install both.

​
Orka3 CLI v3.6.3

orka3 imagecache remove is now generally available (previously early access in 3.6.2). The (Admin-only) label has been removed from the orka3 imagecache add help text; the command does not require administrator privileges. For the full list of changes in this release, see the Orka 3.6.3 release notes.

​
Orka3 CLI v3.6.2

CLI help text image references have been updated. For the full list of changes in this release, see the Orka 3.6.2 release notes.

​
Orka API

In addition to the Orka CLI, MacStadium offers full-featured API integration as well. Check the API Documentation for more details. It covers Orka 4.0 and later. For Orka 3.6, see the Orka 3.6 API reference. You can also use the Swagger UI to run API calls directly against your Orka cluster. Go to <ORKA_API_URL>/api/v1/swagger.

​
Orka Web UI

For a more user-friendly way to manage your Orka environment, you can use the Orka Web UI.

​
CI/CD integrations

MacStadium is constantly working on expanding the list of Orka integrations with leading CI/CD solutions.

​
Orka VM Tools for ARM VMs

Always run matching versions across your Orka cluster, Orka CLI, Orka VM Tools, and any CI/CD integrations. A version mismatch can cause deployment failures, broken image caching, and unexpected behavior. For example, if your cluster runs 3.5.x, your CLI and VM Tools should also run 3.5.x.
Using Homebrew? Run brew install orka-vm-tools for a fresh install. To update an existing installation, run brew upgrade orka-vm-tools. Make sure to commit or save the changes to the base image and redeploy any existing VMs.
Orka VM Tools are guest tools installed on your ARM-based VMs. They enable features like Disk Image Resize and VM Metadata. Visit the links below to download a version of the Orka VM Tools binary that matches your environment.