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.

​
All commands by category

​
Configuration and setup

CommandDescriptionAlias
orka3 config setSet the Orka service URL
orka3 config viewView current CLI configuration
orka3 completionGenerate shell autocompletion
orka3 versionPrint CLI version

​
Authentication

CommandDescriptionAlias
orka3 loginLog in to Orka cluster
orka3 user loginLog in to Orka cluster
orka3 user logoutLog out of Orka cluster
orka3 user get-tokenPrint authentication token
orka3 user set-tokenLog in with token

​
Image management

CommandDescriptionAlias
orka3 image listList local images
orka3 image copyCopy an image
orka3 image generate(Intel-only) Generate empty image
orka3 image deleteDelete images
orka3 image set-descriptionSet image description
orka3 imagecache addCache image on nodesic
orka3 imagecache infoView image caching statusic
orka3 imagecache listList cached imagesic

​
ISO management (Intel only)

CommandDescriptionAlias
orka3 iso listList local ISOs
orka3 iso copyCopy an ISO
orka3 iso deleteDelete ISOs
orka3 iso set-descriptionSet ISO description

​
VM operations

CommandDescriptionAlias
orka3 vm deployDeploy a VM
orka3 vm listList VMs
orka3 vm deleteDelete VMs
orka3 vm saveSave new image from VM
orka3 vm commitUpdate image from VM
orka3 vm resizeResize VM disk
orka3 vm push(ARM-only) Push to OCI registry
orka3 vm get-push-status(ARM-only) View push status
orka3 vm start(Intel-only) Power ON VM
orka3 vm stop(Intel-only) Power OFF VM
orka3 vm suspend(Intel-only) Suspend VM
orka3 vm resume(Intel-only) Resume VM
orka3 vm revert(Intel-only) Revert VM to image

​
VM configuration templates

CommandDescriptionAlias
orka3 vm-config createCreate VM configuration templatevmc
orka3 vm-config listList VM configurationsvmc
orka3 vm-config deleteDelete VM configurationsvmc

​
Infrastructure management (admin)

CommandDescriptionAlias
orka3 node listList nodes
orka3 node tag(Admin) Tag node for affinity
orka3 node untag(Admin) Remove node tag
orka3 node namespace(Admin) Move node to namespace
orka3 namespace create(Admin) Create namespace
orka3 namespace list(Admin) List namespaces
orka3 namespace delete(Admin) Delete namespace

​
Access control (admin)

CommandDescriptionAlias
orka3 serviceaccount create(Admin) Create service accountsa
orka3 serviceaccount list(Admin) List service accountssa
orka3 serviceaccount token(Admin) Get service account tokensa
orka3 serviceaccount delete(Admin) Delete service accountsa
orka3 rolebinding add-subject(Admin) Grant namespace accessrb
orka3 rolebinding list-subjects(Admin) List namespace accessrb
orka3 rolebinding remove-subject(Admin) Revoke namespace accessrb

​
OCI registry integration (admin)

CommandDescriptionAlias
orka3 registrycredential add(Admin) Add registry credentialsregcred
orka3 registrycredential list(Admin) List registry credentialsregcred
orka3 registrycredential remove(Admin) Remove registry credentialsregcred

​
Common flags and options

​
Global flags

FlagDescription
-h, --helpDisplay help for any command
-n, --namespaceSpecify namespace (default: orka-default)
-o, --outputOutput format: table (default), wide, or json

​
VM deployment flags

FlagDescription
-i, --imageBase image (required)
-c, --cpuNumber of CPU cores
-m, --memoryRAM in gigabytes
--nodeSpecific node for deployment
--tagNode affinity tag
--tag-requiredRequire tagged nodes
--configVM configuration template
--generate-nameGenerate unique name with suffix

​
Architecture-specific commands

​
Intel only (amd64)

  • orka3 image generate - Generate empty images
  • orka3 iso commands - Manage ISOs
  • orka3 vm start/stop - Power control
  • orka3 vm suspend/resume - Suspend state
  • orka3 vm revert - Revert to image
  • --iso flag - Attach ISO during deployment
  • --gpu flag - Enable GPU passthrough
  • --system-serial flag - Custom serial number
  • --disable-net-boost flag - Disable network boost

​
Apple silicon only (arm64)

  • orka3 vm push - Push to OCI registry
  • orka3 vm get-push-status - Check push status
  • orka3 imagecache commands - Image caching on nodes
  • OCI image support - Deploy from OCI registries

​
Deprecated commands

The following commands are deprecated and will be removed in future releases. Use OCI registries and orka3 imagecache instead.
  • orka3 remote-image list
  • orka3 remote-image pull
  • orka3 remote-iso list
  • orka3 remote-iso pull