Installation

Welcome to the Installation Instructions for the Ori Global Cloud Command Line Interface (CLI). In this section, we will guide you through the straightforward process of installing the OGC CLI on your system. Whether you're a developer, system administrator, or anyone looking to leverage the power of Ori's cloud platform through the command line, these instructions will ensure you have the necessary tools and configurations in place to get started quickly and seamlessly.

Installation instructions

MacOS and Linux

To install the Ori CLI, run the following installer.

 curl https://raw.githubusercontent.com/ori-edge/ogc-cli-releases/main/install.sh | sh

You now need to configure an environment variable.

export OGC_ACCESS_TOKEN="api|1234567890ABCDE"

Don't forget to replace the field above with your actual API Token. To get an API key, on the OGC Console UI navigate to Settings, then to API Tokens Tab, and click + Add to get a new API Token (documentation).

If you have a problem with the package installation you may be missing required packages like https://jqlang.github.io/jq/. Install with your preferred OS package installer - see the jq download page for detailed instructions.

Windows

Go to the following page and download the version that is appropriate for your platform:

https://github.com/ori-edge/ogc-cli-releases/releases/tag/latest

Unzip the file into your main user directory.

Now set the environment variable:

set  OGC_ACCESS_TOKEN="api|1234567890ABCDE"

Don't forget to replace the field above with your actual API Token.

Verifying your installation

That's it you are now ready to use the CLI. To try it out run:

% ogc vm list-sku

If the installation was successful, you should obtain a list of SKUs available.