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.

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

Update README.md #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you are a complete n00b to coding, you can consult the [n00b's guide to runni

## Install instructions

1. Clone this repository: `git clone [email protected]:socketteer/bingleton-api.git`
1. Clone this repository: `git clone [email protected]:socketteer/clooi.git`
2. Install dependencies with `npm install`
3. Rename `settings.example.js` to `settings.js` in the root directory and change the settings where required.
- **Note**: When pulling changes from this repo, attend to changes to `settings.example.js` which you may want or need to copy over to your settings.js file.
Expand Down
16 changes: 8 additions & 8 deletions n00b-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
To use the CLooI (aka the BCLI), you need to:
- have [git installed](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- have [Node.js and npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- clone the files of this project onto your computer using `git clone https://github.com/socketteer/bingleton-api.git`
- clone the files of this project onto your computer using `git clone https://github.com/socketteer/clooi.git`
- install the dependencies of the project using the `npm install` command
- rename the `settings.example.js` file to `settings.js`
- Set API key(s) as environmental variables
Expand All @@ -23,30 +23,30 @@ To use the CLooI (aka the BCLI), you need to:

in a command line, navigate to a directory where you want these files to live and run
```
git clone [email protected]:socketteer/bingleton-api.git
git clone [email protected]:socketteer/clooi.git
```
This will create a folder called `bingleton-api`
This will create a folder called `clooi`

- If you get an error saying git is not installed or command git not found, [install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) first
- If it says you do not have permissions, you probably have to [set up a personal access token](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).

### 2 installing dependencies

Inside the `bingleton-api` folder, run `npm install`. This will install all the rest of the dependencies that the code uses.
Inside the `clooi` folder, run `npm install`. This will install all the rest of the dependencies that the code uses.

- if you get an error saying npm is not installed/found, [install Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) first.

### 3 setting up settings

Rename `settings.example.js` (a file in `bingleton-api`) to `settings.js` in the root directory. When you pull updates in the future, you may need to do this step again.
Rename `settings.example.js` (a file in `clooi`) to `settings.js` in the root directory. When you pull updates in the future, you may need to do this step again.

### 4 setting API keys

For Claude, you will have to set your Anthropic API key as an environmental variable. To do this, run
```
export ANTHROPIC_API_KEY=<your anthropic api key>
```
in the `bingleton-api` folder.
in the `clooi` folder.

For infrastructs using OpenAI base models, you will have to set `OPENAI_API_KEY` in the same way.

Expand All @@ -56,6 +56,6 @@ To start the Bingleton Command Loom interface, simply run the command
```
npm run cli
```
in the `bingleton-api` folder.
in the `clooi` folder.

See [README.md](./README.md) (also one of the files in the `bingleton-api` folder that you cloned) for documentation about commands and settings.
See [README.md](./README.md) (also one of the files in the `clooi` folder that you cloned) for documentation about commands and settings.