Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Octavia/Dylan - README updates for clarity #72

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Octavia/Dylan - README updates for clarity #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ The RelationalAI (RAI) CLI provides access to the RAI APIs from the command line

### Building the CLI

Update dependencies with the `tidy` script
1. Update dependencies with the `tidy` script

./tidy

Build the `rai` binary using the `go` tool
2. Build the `rai` binary using the `go` tool

go build -o build/rai rai/*

.. or use the handy `make` script

./make

Installation consists of simply putting the `rai` binary on your path.
Installation consists of simply putting the `rai` binary that was generated in the build folder in step 2 on your path.

### Create a configuration file

Expand All @@ -42,8 +42,8 @@ client_secret = <your client secret>
# client_credentials_url = https://login.relationalai.com/oauth/token
```

Client credentials can be created using the RAI console at
https://console.relationalai.com/login
Client credentials can be created using the [RAI console](https://console.relationalai.com/login) by going to Settings -> Users


You can copy `config.spec` from the root of this repo and modify as needed.

Expand Down