diff --git a/README.md b/README.md index 22debc0..1b83546 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com:socketteer/bingleton-api.git` +1. Clone this repository: `git clone git@github.com: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. diff --git a/n00b-guide.md b/n00b-guide.md index e0452be..339edaa 100644 --- a/n00b-guide.md +++ b/n00b-guide.md @@ -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 @@ -23,22 +23,22 @@ 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 git@github.com:socketteer/bingleton-api.git +git clone git@github.com: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/enterprise-server@3.4/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 @@ -46,7 +46,7 @@ For Claude, you will have to set your Anthropic API key as an environmental vari ``` export 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. @@ -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.