Skip to content
/ aura-cli Public

The Neo4j Aura Command Line Interface (CLI) is a powerful tool designed to simplify and streamline the management of your Neo4j Aura resources from the command line

License

Notifications You must be signed in to change notification settings

neo4j/aura-cli

Neo4j CLI

Installation

Downloadable binaries are available from the releases page.

Download the appropriate archive for for operating system and architecture.

Usage

Extract the executable to a directory of your choosing.

Create Aura API Credentials in your Account Settings, and note down the client ID and secret.

Add these credentials into the CLI with a name of your choosing:

./aura-cli credential add --name "Aura API Credentials" --client-id <client-id> --client-secret <client-secret>

This will add and set the credential as the default credential for use.

You can then, for example, list your instances in a table format:

./aura-cli instance list --output table

If you would rather just type aura-cli then move the aura-cli binary into the file path of your computer.
Windows:

move aura-cli c:\windows\system32

Mac:

sudo mv aura-cli /usr/local/bin

To see all of the available commands:

./aura-cli

Help for each command is accessed by using it without any flags or options. For example, to see help creating an instance

./aura-cli instance create

Feedback / Issues

Please use GitHub issues to provide feedback and report any issues that you have encountered.

Developing and contributing

Read CONTRIBUTING.md

About

The Neo4j Aura Command Line Interface (CLI) is a powerful tool designed to simplify and streamline the management of your Neo4j Aura resources from the command line

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Languages