oasisctl

README

Oasisctl

Commandline utility for accessing ArangoDB Oasis.

This utility is used to access ArangoDB Oasis resources (such as projects, deployments, certificates) without the needs for a graphical dashboard. It is often used in scripts.

Maintainers

This utility is maintained by the team at ArangoDB.

Installation

Run:

go get github.com/arangodb-managed/oasisctl

Usage

oasisctl [command...]

A list of commands and options can be shown using:

oasisctl -h

Authentication

Oasisctl uses an authentication token to authenticate with the ArangoDB Oasis platform.

To get such an authentication token, create an API key and run:

oasisctl login \
  --key-id=<your-key-id> \
  --key-secret=<your-key-secret>

The output is the authentication token. The most convenient use is to put it in an OASIS_TOKEN environment variable. In a script that can be done like this:

export OASIS_TOKEN=$(oasisctl login --key-id=<your-key-id> --key-secret=<your-key-secret>)

More information

More information and a getting started guide about Oasisctl is available at arangodb.com/docs/stable/oasis.

Documentation

Overview

AUTO-GENERATED by Zutano