Skip to content

Commit

Permalink
chore: install cli instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ydennisy committed Nov 19, 2023
1 parent 575e201 commit 32506d5
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,21 @@ Not much yet:
- You are able to add a `node`, which can be text, link or a combination.
- You are able to search these using dense embeddings.
- You can chat with an AI using the `nodes` stored in KG1 (RAG).

## Usage

The current version is for bleeding edge early adopters!

Install the CLI from NPM:

```
npm i kg1-cli -g
```

You can now use the CLI, locally to interact with KG1:

```
kg1 add "A new note about something which is very interesting!"
kg1 search "how do racoons make love?"
kg1 chat "why is the world flat?"
```

0 comments on commit 32506d5

Please sign in to comment.