CLI and API FAQs

Frequently asked questions about the Orka CLI and the Orka API.

๐Ÿ“˜

Orka 2.4.x content

This page has not been updated to reflect the changes introduced in Orka 3.0. Some of the information might be outdated or incorrect. Use 2.4.x to 3.0.0: API Mapping and 2.4.x to 3.0.0: CLI Mapping to figure out the correct endpoints and commands.

Can I install the Orka CLI with Homebrew?

Yes. Orka CLI is available via Homebrew and can be installed using brew install orka.

What output types are supported?

The Orka API provides a combination of response codes and JSON output for responses.

Currently, the Orka CLI provides JSON output for some commands. The team is gradually implementing JSON support throughout the CLI.

For more information, see CLI Commands: Change the output.


ยฉ 2019-2023 Copyright MacStadium, Inc. โ€“ Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.