Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.macstadium.com/llms.txt

Use this file to discover all available pages before exploring further.

Tools for accessing the Orka service. CI/CD integrations for Orka.

​
Orka3 CLI

Visit the links below to download a version of the Orka CLI binary that matches your environment.
ReleaseNotesmacOS ARMmacOS AMDLinuxWindows
Orka3 CLI v3.6.1 (Latest)What’s newDownloadDownloadDownloadDownload
Orka3 CLI v3.6.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.5.2Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.5.1Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.5.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.4.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.3.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.2.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.1.0Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.0.2Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.0.1Release notesDownloadDownloadDownloadDownload
Orka3 CLI v3.0.0Release notesDownloadDownloadDownloadDownload
Complete the installation
  • On macOS, run the orka3.pkg package and complete the installation.
  • On Linux, unpack the archive and move the orka3 executable 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? Try brew install --cask orka3.

​
Orka3 CLI v3.6.1

Bug fix: Fixed an issue where the Orka CLI did not support private NAT IP addresses. Customers whose environments use a private address space for NAT IPs can now connect to their Orka clusters without issue. No configuration changes are required.

​
Orka3 API

In addition to the Orka CLI, MacStadium offers full-featured API integration as well. Check the API Documentation for more details. 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.
ReleasemacOS ARM
Orka VM Tools v3.6.0 (Latest)Download
Orka VM Tools v3.5.2Download
Orka VM Tools v3.5.0Download
Orka VM Tools v3.3.0Download
Orka VM Tools v3.0.2Download
Orka VM Tools v3.0.0Download