Overview

Onqlave CLI is a cli executable package for developers to interact with Onqlave resources via command line interface.

Release asset

• CLI release will contain a release note of the docker image repository.
• CLI packages for Linux, macOS, and Windows are automatically created and uploaded as assets in each release.

Download Onqlave CLI

Linux

• Download Linux executable file onqlave-linux from the release assets
• Grant executable permission to onqlave-linux file

sudo chmod +x onqlave-linux

• Make sure onqlave-linux is executable:

./onqlave-linux

MacOS

• Download Linux executable file onqlave-darwin from the release assets
• Grant executable permission to onqlave-darwin file

sudo chmod +x onqlave-darwin

• Make sure onqlave-darwin is executable:

./onqlave-darwin

Windows

• Download Windows executable file onqlave-windows.exe from the release assets
• Make sure onqlave-windows.exe is executable:

.\onqlave-windows.exe

Docker

• Download the Docker image from the CLI release note

docker pull ghcr.io/onqlavelabs/onqlavelabs/onqlave.cli:{$version}

• Verify the Docker image

docker images

The Docker image for the CLI package should be visible in the Docker images list:

REPOSITORY                                   TAG         IMAGE ID       CREATED         
ghcr.io/onqlavelabs/onqlavelabs/onqlave.cli  {$version}  ${image-id}   10 seconds ago

• Run the Docker image in interactive mode

docker run -it ${image-id}

If you want to save the config file permanently, or you want to use an existing config file, you can mount the directory that contains the config file when running the docker container

docker run -it -v ${path-to-config-file}:/root/.config/onqlave ${image-id}

• Make sure onqlave CLI package inside the docker image is executable:

bash-5.2# onqlave

Result

Usage:
  onqlave [command]

Examples:
onqlave

Available Commands:
  application application management
  arx         arx management
  auth        authentication
  completion  Generate the autocompletion script for the specified shell
  config      config environment variables
  help        Help about any command
  key         api key management
  tenant      tenant management
  user        user management

Flags:
  -h, --help      help for onqlave
      --json      JSON Output. Set to true if stdout is not a TTY.
  -v, --version   version for onqlave

Use "onqlave [command] --help" for more information about a command.

Installation Script

• An installation shell script is provided to download any specific Onqlave CLI version
• Download and execute the installation script:

curl -s "https://raw.githubusercontent.com/onqlavelabs/onqlave.cli/main/scripts/install.sh" | bash -s ${cli-version}

• For Windows users, it is recommended to have bash executable installed such as git bash before using the installation script; or you can download the CLI executable directly from the release.

How to use Onqlave CLI

Configure environment

• Make sure you have a working Onqlave CLI executable
• Configure the environment by execute the following command:

onqlave config init

• Make sure the environment is configured by execute the following command:

onqlave config current

• A configured environment should be as follows:

┌───────────────────────────────────────────┐
│ Key          Value                            │
│───────────────────────────────────────────│
│ ApiBaseUrl   https://api.onqlave.com          │
│ ConfigPath   /root/.config/onqlave/config     │
│ Env          prod                             │
│ TenantId                                      │
│ TenantName                                    │
└───────────────────────────────────────────┘

Start using the CLI

Full documentation of using the CLI can be found here