> ## 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.

# Orka CLI command quick reference

> Quick-reference tables for all Orka CLI commands: configuration, authentication, VMs, images, nodes, namespaces, and service accounts.

> [!NOTE]
>
> Starting with Orka 4.0, the CLI command is `orka`. On Orka 3.6 and earlier, it's `orka3`: replace `orka` with `orka3` in the examples on this page. Commands marked as removed in Orka 4.0 only exist in `orka3`.

## All commands by category

### Configuration and setup

| Command | Description | Alias |
| - | - | - |
| `orka config set` | Set the Orka service URL | |
| `orka config view` | View current CLI configuration | |
| `orka completion` | Generate shell autocompletion | |
| `orka version` | Print CLI version | |

### Authentication

| Command | Description | Alias |
| - | - | - |
| `orka login` | Log in to Orka cluster | |
| `orka user login` | Log in to Orka cluster | |
| `orka user logout` | Log out of Orka cluster | |
| `orka user get-token` | Print authentication token | |
| `orka user set-token` | Log in with token | |

### Image management

| Command | Description | Alias |
| - | - | - |
| `orka image list` | (Deprecated) List local images | |
| `orka image copy` | (Deprecated) Copy an image | |
| `orka3 image generate` | (Intel-only, removed in Orka 4.0) Generate empty image | |
| `orka image delete` | (Deprecated) Delete images | |
| `orka image set-description` | (Deprecated) Set image description | |
| `orka imagecache add` | Cache image on nodes | `ic` |
| `orka imagecache info` | View image caching status | `ic` |
| `orka imagecache list` | List cached images | `ic` |
| `orka imagecache remove` | Remove cached image from nodes | `ic` |

### ISO management (Intel only, removed in Orka 4.0)

| Command | Description | Alias |
| - | - | - |
| `orka3 iso list` | List local ISOs | |
| `orka3 iso copy` | Copy an ISO | |
| `orka3 iso delete` | Delete ISOs | |
| `orka3 iso set-description` | Set ISO description | |

### VM operations

| Command | Description | Alias |
| - | - | - |
| `orka vm deploy` | Deploy a VM | |
| `orka vm list` | List VMs | |
| `orka vm delete` | Delete VMs | |
| `orka vm save` | (Deprecated) Save new image from VM | |
| `orka vm commit` | (Deprecated) Update image from VM | |
| `orka vm resize` | Resize VM disk | |
| `orka vm push` | (ARM-only) Push to OCI registry | |
| `orka vm get-push-status` | (ARM-only) View push status | |
| `orka3 vm start` | (Intel-only, removed in Orka 4.0) Power ON VM | |
| `orka3 vm stop` | (Intel-only, removed in Orka 4.0) Power OFF VM | |
| `orka3 vm suspend` | (Intel-only, removed in Orka 4.0) Suspend VM | |
| `orka3 vm resume` | (Intel-only, removed in Orka 4.0) Resume VM | |
| `orka3 vm revert` | (Intel-only, removed in Orka 4.0) Revert VM to image | |

### VM configuration templates

| Command | Description | Alias |
| - | - | - |
| `orka vm-config create` | Create VM configuration template | `vmc` |
| `orka vm-config list` | List VM configurations | `vmc` |
| `orka vm-config delete` | Delete VM configurations | `vmc` |

### Infrastructure management (admin)

| Command | Description | Alias |
| - | - | - |
| `orka node list` | List nodes | |
| `orka node tag` | (Admin) Tag node for affinity | |
| `orka node untag` | (Admin) Remove node tag | |
| `orka node namespace` | (Admin) Move node to namespace | |
| `orka namespace create` | (Admin) Create namespace | |
| `orka namespace list` | (Admin) List namespaces | |
| `orka namespace delete` | (Admin) Delete namespace | |

### Android emulators (Apple silicon only)

| Command | Description | Alias |
| - | - | - |
| `orka emulator deploy` | Deploy an Android emulator paired with a running VM | `emu` |
| `orka emulator list` | List Android emulators | `emu` |
| `orka emulator delete` | Delete an Android emulator | `emu` |
| `orka emulator-config create` | Create an emulator configuration (Orka 4.0 or later) | `emc` |
| `orka emulator-config list` | List emulator configurations (Orka 4.0 or later) | `emc` |
| `orka emulator-config delete` | Delete emulator configurations (Orka 4.0 or later) | `emc` |

### Access control (admin)

| Command | Description | Alias |
| - | - | - |
| `orka serviceaccount create` | (Admin) Create service account | `sa` |
| `orka serviceaccount list` | (Admin) List service accounts | `sa` |
| `orka serviceaccount token` | (Admin) Get service account token | `sa` |
| `orka serviceaccount delete` | (Admin) Delete service account | `sa` |
| `orka rbac add-subject` | (Admin) Grant a role (admin or dev) to subjects (Orka 4.0 or later) | |
| `orka rbac list-subjects` | (Admin) List subjects granted a role (Orka 4.0 or later) | |
| `orka rbac remove-subject` | (Admin) Revoke a role from subjects (Orka 4.0 or later) | |
| `orka rolebinding add-subject` | (Admin, deprecated) Grant namespace access | `rb` |
| `orka rolebinding list-subjects` | (Admin, deprecated) List namespace access | `rb` |
| `orka rolebinding remove-subject` | (Admin, deprecated) Revoke namespace access | `rb` |

### OCI registry integration (admin)

| Command | Description | Alias |
| - | - | - |
| `orka registrycredential add` | (Admin) Add registry credentials | `regcred` |
| `orka registrycredential list` | (Admin) List registry credentials | `regcred` |
| `orka registrycredential remove` | (Admin) Remove registry credentials | `regcred` |

## Common flags and options

### Global flags

| Flag | Description |
| - | - |
| `-h, --help` | Display help for any command |
| `-n, --namespace` | Specify namespace (default: orka-default) |
| `-o, --output` | Output format: table (default), wide, or json |

### VM deployment flags

| Flag | Description |
| - | - |
| `-i, --image` | Base image (required) |
| `-c, --cpu` | Number of CPU cores |
| `-m, --memory` | RAM in gigabytes |
| `--node` | Specific node for deployment |
| `--tag` | Node affinity tag |
| `--tag-required` | Require tagged nodes |
| `--config` | VM configuration template |
| `--generate-name` | Generate unique name with suffix |
| `--userdata` | Bootstrap script run on the VM's first boot (Orka 4.0 or later) |

## Architecture-specific commands

### Intel only (amd64, Orka 3.6 and earlier)

Orka 4.0 supports Apple silicon only and removed these commands and flags. They return an unknown-command or unknown-flag error on Orka 4.0.

* `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
* `--legacy-io` flag - Legacy IO
* `orka3 vm resize --user/--password` - Automatic repartition over SSH

### Apple silicon only (arm64)

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

## Deprecated commands

The following commands are deprecated as of Orka 4.0 and will be removed in a future release. They still work, but print a deprecation warning.

**NFS-hosted images.** Use OCI images instead, created with `orka vm push`, and use `orka imagecache` to load images onto nodes.

* `orka image list`, `copy`, `delete`, and `set-description`
* `orka remote-image list` and `pull`
* `orka vm save` and `orka vm commit`

**Rolebindings.** Use `orka rbac` with `--role dev` instead.

* `orka rolebinding add-subject`, `list-subjects`, and `remove-subject`

`orka3 remote-iso list` and `pull` were removed in Orka 4.0 along with the other ISO commands.


## Related topics

- [Ansible quick reference](https://docs.macstadium.com/remote-desktop-vdi/reference/ansible-quick-reference.md)
- [MacStadium VDI troubleshooting quick reference](https://docs.macstadium.com/remote-desktop-vdi/reference/troubleshooting-quick-reference.md)
- [Deploy your first VM with the Orka CLI](https://docs.macstadium.com/orka/quick-start-guides/orka-cli-quick-start.md)
- [Orka CI/CD integrations quick start guide](https://docs.macstadium.com/orka/quick-start-guides/cicd-integrations-quick-start.md)
- [Orka namespace management with the CLI](https://docs.macstadium.com/orka/orka-cli-reference/namespace-management.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.