Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
darrellwarde authored Oct 31, 2024
1 parent 7bd42a7 commit d7ce802
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@

Downloadable binaries are available from the [releases](https://github.com/neo4j/cli/releases/latest) 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](https://console.neo4j.io/#account), and note down the client ID and secret.

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

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

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

You can then, for example, list your instances:

```bash
./neo4j-cli aura instance list

## Development

### Testing
Expand Down

0 comments on commit d7ce802

Please sign in to comment.