Skip to content

Commit b862b42

Browse files
authored
Merge pull request #111 from LackOfMorals/main
Updated README.md
2 parents 72f6a0e + c4843cd commit b862b42

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,39 @@ Create Aura API Credentials in your [Account Settings](https://console.neo4j.io/
1515
Add these credentials into the CLI with a name of your choosing:
1616

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

21-
This will add the credential and set it as the default credential for use.
21+
This will add and set the credential as the default credential for use.
2222

23-
You can then, for example, list your instances:
23+
You can then, for example, list your instances in a table format:
2424

2525
```bash
26-
./neo4j-cli aura instance list
26+
./aura-cli instance list --output table
2727
```
2828

29+
If you would rather just type ```aura-cli``` then move the aura-cli binary into the file path of your computer.
30+
Windows:
31+
```bash
32+
move aura-cli c:\windows\system32
33+
```
34+
Mac:
35+
```bash
36+
sudo mv aura-cli /usr/local/bin
37+
```
38+
39+
To see all of the available commands:
40+
```bash
41+
./aura-cli
42+
```
43+
Help for each command is accessed by using it without any flags or options. For example, to see help creating an instance
44+
```bash
45+
./aura-cli instance create
46+
```
47+
48+
## Feedback / Issues
49+
Please use [GitHub issues](https://github.com/neo4j/aura-cli/issues) to provide feedback and report any issues that you have encountered.
50+
2951
## Development
3052

3153
### Testing

0 commit comments

Comments
 (0)