Skip to main content

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 provide three environment variables. Alternatively you can your context as shown further below.

export OGC_USERNAME="joe@myorganisation.io";
export OGC_PASSWORD="mypasswordisunguessable!";
export OGC_ENV="myorg";
export OGC_ORG_ID="d7a99999-28c9-4e94-b591-cbc21cebe6ae";

Don't forget to replace the fields above with your actual user name and your actual password. You can obtain your Org ID from the browser URL of your Organisation.

For example if your URL is: https://console.ogc.ori.co/organisations/d7a99999-28c9-4e94-b591-cbc21cebe6ae/dashboard

Your Org ID is: d7a99999-28c9-4e94-b591-cbc21cebe6ae

Instead of setting your env vars, you can set a profile. To do that, run the following command:

echo '{
   "username": "joe@myorganisation.io",
   "password": "mypasswordisunguessable!",
   "env": "myorg",
   "org_id": "d7a99999-28c9-4e94-b591-cbc21cebe6ae"
}' > ~/.ogc/myorg

As per the note above, don't forget to replace with the actual correct details.

And then point the OGC_PROFILE env_var to your configuration

export OGC_PROFILE=myorg

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.

On the <user>/.ogc/ directory create a new file called myorg (or something appropriate) and add the following content to it:

{
   "username": "joe@myorganisation.io",
   "password": "mypasswordisunguessable!",
   "env": "myorg",
   "org_id": "d7a99999-28c9-4e94-b591-cbc21cebe6ae"
}

Don't forget to replace the fields above with your actual user name and your actual password. You can obtain your Org ID from the browser URL of your Organisation.

For example if your URL is: https://console.ogc.ori.co/organisations/d7a99999-28c9-4e94-b591-cbc21cebe6ae/dashboard

Your Org ID is: d7a99999-28c9-4e94-b591-cbc21cebe6ae

Now you need to set the environment variable for the profile you created

set OGC_PROFILE=prod

If using Powershell set he following environment variable

$env:OGC_PROFILE = "prod"