Skip to main content

​
Getting Started with orka3

Basic Usage The Orka3 CLI follows a consistent command structure: 
orka3 [command] [subcommand] [flags]
Global Help 
orka3 --help
Available Options 
-h, --help   Display help for orka3
Main Command Groups
  • orka3 completion - Generate autocompletion scripts for your shell
  • orka3 config - Manage the local Orka CLI configuration
  • orka3 image - Manage locally stored images
  • orka3 imagecache - Manage individual cluster node(s) image cache
  • orka3 iso - Manage locally stored ISOs
  • orka3 login - Log in to your Orka cluster
  • orka3 namespace - (Admin-only) Manage namespaces
  • orka3 node - Manage Orka nodes
  • orka3 registrycredential - (Admin-only) Manage OCI registry credentials
  • orka3 rolebinding - (Admin-only) Manage rolebindings
  • orka3 serviceaccount - (Admin-only) Manage service accounts
  • orka3 user - Manage your authentication with Orka
  • orka3 version - Print the current version of the Orka CLI
  • orka3 vm - Manage VMs
  • orka3 vm-config - Manage VM configurations

​
Configuration Commands

The orka3 config command group manages your local Orka CLI configuration. The first time you run the Orka CLI, you must set the Orka service URL. All Orka CLI commands are executed against this address. orka3 config set Set the Orka service URL for your environment. Syntax: 
orka3 config set --api-url ORKA_SERVICE_URL [flags]
Determining Your Service URL:
  • For environments initially deployed with Orka 2.1 or later : typically http://10.221.188.20
  • For environments initially deployed before Orka 2.1 : typically http://10.221.188.100
You can also use the built-in Orka domain (COMPANY.orka.app) or an external custom domain if configured. Options: 
-a, --api-url string   (Required) The Orka service URL
-h, --help             Display help for set
Examples: 
# Set your Orka service URL to 10.221.188.20 (Orka 2.1+)
orka3 config set --api-url http://10.221.188.20

# Set your Orka service URL to 10.221.188.100 (pre-Orka 2.1)
orka3 config set --api-url http://10.221.188.100

# Set your Orka service URL to your built-in Orka domain
orka3 config set --api-url https://company.orka.app

# Set your Orka service URL to an external custom domain
orka3 config set --api-url https://company.com
orka3 config view View the current local Orka CLI configuration. Syntax: 
orka3 config view [flags]
Options: 
-h, --help   Display help for view
Examples: 
# Print your current Orka CLI configuration
orka3 config view

​
Shell Completion Setup

The Orka CLI can generate autocompletion scripts for your shell, making it easier to discover commands and options. Supported Shells
  • bash
  • fish
  • powershell
  • zsh
Generate Completion Script 
orka3 completion [shell]
See each sub-command’s help for details on how to use the generated script. Options: 
-h, --help   Display help for completion
Bash Completion This script depends on the bash-completion package. If it is not installed, install it via your OS’s package manager. Load completions in the current shell session: 
source <(orka3 completion bash)
Load completions for every new session (Linux): 
orka3 completion bash > /etc/bash_completion.d/orka3
Load completions for every new session (macOS): 
orka3 completion bash > $(brew --prefix)/etc/bash_completion.d/orka3
A new shell must be started for this setup to take effect. Options: 
-h, --help              Display help for bash
--no-descriptions       Disable completion descriptions
Fish Completion Load completions in the current shell session: 
orka3 completion fish | source
Load completions for every new session: 
orka3 completion fish > ~/.config/fish/completions/orka3.fish
A new shell must be started for this setup to take effect. Syntax: 
orka3 completion fish [flags]
Options: 
-h, --help              Display help for fish
--no-descriptions       Disable completion descriptions
PowerShell Completion Load completions in your current shell session: 
orka3 completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command to your PowerShell profile. Syntax: 
orka3 completion powershell [flags]
Options: 
-h, --help              Display help for powershell
--no-descriptions       Disable completion descriptions
Zsh Completion If shell completion is not already enabled in your environment, enable it first: 
echo "autoload -U compinit; compinit" >> ~/.zshrc
Load completions in the current shell session: 
source <(orka3 completion zsh)
Load completions for every new session (Linux): 
orka3 completion zsh > "${fpath[1]}/_orka3"
Load completions for every new session (macOS): 
orka3 completion zsh > $(brew --prefix)/share/zsh/site-functions/_orka3
A new shell must be started for this setup to take effect. Syntax: 
orka3 completion zsh [flags]
Options: 
-h, --help              Display help for zsh
--no-descriptions       Disable completion descriptions

​
Checking CLI Version

orka3 version Print the current version of the Orka CLI. Syntax: 
orka3 version [flags]
Options: 
-h, --help   Display help for version
Examples: 
# Print the current version of the Orka CLI
orka3 version
The version output includes information about the CLI build and compatibility with your Orka cluster.