Installation guide written for people without coding experience.
Tip: I highly recommend asking a language model to help with the installation if you run into any difficulties. You can paste this whole guide into the conversation as context.
To use the CLooI (aka the BCLI), you need to:
- have git installed
- have Node.js and npm installed
- clone the files of this project onto your computer using
git clone https://github.com/socketteer/bingleton-api.git - install the dependencies of the project using the
npm installcommand - rename the
settings.example.jsfile tosettings.js - Set API key(s) as environmental variables
- launch the CLooI using
npm run cli
(same as overview, but in more detail)
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
This will create a folder called bingleton-api
- If you get an error saying git is not installed or command git not found, install git first
- If it says you do not have permissions, you probably have to set up a personal access token.
Inside the bingleton-api 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 first.
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.
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.
For infrastructs using OpenAI base models, you will have to set OPENAI_API_KEY in the same way.
To start the Bingleton Command Loom interface, simply run the command
npm run cli
in the bingleton-api folder.
See README.md (also one of the files in the bingleton-api folder that you cloned) for documentation about commands and settings.