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 environment.
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 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 overridden if environment variables for the Client ID or Client Secret are set.
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_CLI_OUTPUT- The default output format. Defaults to
AURA_CLI_SAVE_LOGS- Flag whether CLI logs are saved to a file. Defaults to
AURA_CLI_LOG_FILE_PATH- The path to the file where logs are saved. Defaults to
Setting environment variables will override any configurations that were set with the
aura config set command.
aura config commands allows to set configurations and default values. Currently there are 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 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
List of all config commands:
aura config get
aura config list
aura config set
aura config unset
API commands are divided into 3 resources:
snapshots. Use the
--help flag to get more information about each subcommand, e.g.
aura instances --help.
aura instances get --name DevInstance
aura instances create --name DevInstance --cloud-provider gcp --region europe-west1 --type professional-db --tenant-id my-tenant-123
aura snapshots list --instance-id=b25d4b9f
By default the output format is json. Using the
output option the format can be changed to
aura instances list --output table
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.
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
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.