The Orka CLI provides access to your Orka environment from the command line.

📘

IMPORTANT

Currently, the Orka CLI is distributed as an unsigned package. On macOS, you will be prompted that the app cannot be opened because it's from an unidentified developer. This behavior is expected.

Follow Apple's instructions to add the Orka CLI as a security exception.

Input modes

The Orka CLI lets you choose between an interactive input mode or direct input mode.

In interactive mode, you can run the command without specifying any additional parameters, such as names, IDs, etc. Once you hit Enter, the Orka CLI prompts you to provide the information required to run the command.

In direct mode, you can provide all the information required by the command through the use of the designated flags and parameters. The Orka CLI prompts you to confirm the provided information.

👍

TIP: Non-interactive console?

To bypass the command prompts for information, use direct mode and use the respective command flags.

To bypass the confirmation, pass the -y or the --assume-yes flags.

Using chaining operators with the Orka CLI

You can run multiple commands by using the standard bash chaining command-line operators: && and ;.

List all commands

To list all available commands, type:

orka

For more information about each group of commands, see the sub-pages in this section.

Get help

To get help in the Orka CLI, type:

orka help

OR

orka <COMMAND> --help

Change the output

By default, the Orka CLI returns the output of all list commands in a TABLE format. You can choose to switch to JSON instead.

The following commands support JSON output instead of TABLE output:

• orka user list
• orka vm list (including admin operations)
• orka node list
• orka image list
• orka image list-remote
• orka iso list
• orka iso list-remote
• orka kube list

You can switch to JSON globally or for a particular command:

• To switch to JSON globally, run orka config and, when prompted, set Output style: to JSON.
• To get JSON output for particular commands, pass the --json flag to the supported commands (see above).

👍

Do you need 100% JSON output?

Switch to using the Orka API instead.