Beeker CLI

Introduction

This Command line tool allows you to run beeker actions in your local repository.

Beeker is based on Node.js, so you need to get it installed on your machine.

You can use this CLI for free if you provide your own OpenAI api key. (no beeker account required)

Purchase an api key on OpenAI website : https://openai.com/api/ (opens in a new tab)
Create a .beekconfig.yml file at root in your project :

.beekconfig.yml

openai_organization: your-org
openai_api_key: your-api-key
openai_model: gpt-4o

Don't forget to change 'your-org' and 'your-api-key' with your OpenAI organization id and your OpenAI api key.

.gitignore

# ... other files ignored
.beekconfig.yml

Alternatively, you can purchase a paid beeker account and skip this setup (OpenAI services are provided with your paid account).

To get started, you can install our command line tool with the package manager of your choice:

This is the recommended way if your project is no managed with npm packages (usually projects with other languages than javascript).

This is the recommended way if you work in a project managed with npm packages (usually javascript projects).