Aura Command Line Interface

The Neo4j Aura CLI is an open source command line interface for interacting with the Aura cloud platform through the public Aura API.

You can sign up for Aura here: https://console.neo4j.io

To find out more about about the Aura API visit the documentation: https://neo4j.com/docs/aura/platform/api/overview/

Installation

To install the CLI you need to have Python and pip installed. Then you can run:

pip install aura-cli

to download and install the CLI. As with other Python libraries, you should consider installing it in a virtual environemnt.

Usage

After installation, the aura command will be available in your terminal. You can verify that the installation was successful by running aura --version or aura --help.

Credentials

Aura API credentials need to be created in the console (see the Aura API documentation). These can then be added to the CLI through the aura credentials add command. The credentials will then be saved locally in a config file. You can add multiple credentials and switch between them.

To add your first credentials run aura credentials add --name <NAME> --client-id <YOUR_CLIENT_ID> --client-secret <YOUR_CLIENT_SECRET> --use

Here is a list of all credentials commands:

• aura credentials add
• aura credentials list
• aura credentials current
• aura credentials use
• aura credentials delete

Configured credentials will be overriden if environment variables for the Client ID or Client Secret are set.

Environment Variables

There are 8 environment variables that can be set for use in the CLI:

• AURA_CLI_AUTH_URL - The url used for getting an auth token (defaults to https://api.neo4j.io/oauth/token)
• AURA_CLI_BASE_URL - The base url used for all API calls (defaults to https://api.neo4j.io/v1)
• AURA_CLI_CLIENT_ID - The client id used for authentication
• AURA_CLI_CLIENT_SECRET - The client secret used for authentication
• AURA_CLI_CONFIG_PATH - The path to the CLI's config file. Defaults to ~/.aura/config.json
• AURA_CLI_OUTPUT - The default output format. Defaults to json.
• AURA_CLI_SAVE_LOGS - Flag whether CLI logs are saved to a file. Defaults to false.
• AURA_CLI_LOG_FILE_PATH - The path to the file where logs are saved. Defaults to ~/.aura/auracli.log.

Setting environment variables will override any configurations that were set with the aura config set command.

Config

The aura config commands allows to set configurations and default values. Currently there 6 options which can be set with the aura config set command:

• default_tenant - the default tenant which to use for commands like aura instances create (where a tenant-id is required)
• output - the default output format for API commands (json, text, yaml or table)
• auth_url - The url used for getting an auth token (default to https://api.neo4j.io/oauth/token)
• base_url - The base url used for all API calls (defaults to https://api.neo4j.io/v1)
• save_logs - Whether to save CLI logs in a log file. Defaults to false. Allowed values: "true", "yes", "false", "no"
• log_file_path - The path to the file where logs are saved. Defaults to ~/.aura/auracli.log

List of all config commands:

• aura config get
• aura config list
• aura config set
• aura config unset

API Commands

API commands are divided into 3 resources: instances, tenants and snapshots. Use the --help flag to get more information about each subcommand, e.g. aura instances --help.

Example commands:

aura instances get --name DevInstance

aura instances create --name DevInstance --region europe-west1 --type professional-db --tenant-id my-tenant-123

aura snapshots list --instance-id=b25d4b9f

Output format

By default the output format is json. Using the output option the format can be changed to table, text or yaml, e.g.

aura instances list --output table

Useful flags

All API commands have the following 3 flags:

• --include, -i : Print the API response headers
• --raw : Print the raw API response body
• --verbose : Print verbose output
• --wait : Can be used for async operations like creating an instance. Command will wait until the operation is finished.

Logs

The CLI will generate logs which can be printed using the --verbose flag. By default these logs are not saved, but setting the AURA_CLI_SAVE_LOGS environment variable or the save_logs config option to true or yes will write the logs to a file. The default location of the log file is ~/.aura/auracli.log, but this can be changed by setting the AURA_CLI_LOG_FILE_PATH environment variable or the log_file_path config option.

Development

To install the CLI and its dependencies for development, do the following:

In the root of the repository, run python3 -m venv .venv to create a virtual environment.

Next, run . .venv/bin/activate to activate the virtual environment.

Next, run pip install --editable . to install the dependencies. Then you can run the CLI using aura --help.

When finished, run deactivate to deactivate the virtual environment.

To run the unit tests, run pytest tests/unit.

For development you will need the following Python libraries installed:

• pytest
• black
• pylint
• pre-commit
• pytest-cov