Quickstart

Clone the starter repo

Chose your prefered programming language and get started with the BeeAI Framework starter template.

git clone https://github.com/i-am-bee/beeai-framework-py-starter.git
cd beeai-framework-py-starter

git clone https://github.com/i-am-bee/beeai-framework-ts-starter.git
cd beeai-framework-ts-starter

Install the dependencies

If you’re using python, make sure you have uv installed.

uv sync

nvm install && nvm use
npm ci

Configure your Enviorment Variables

Create an .env file with the contents from .env.template

cp .env.template .env

Copy-Item .env.template .env

copy .env.template .env

Configure your LLM Backend

If you choose to run a local model, Ollama must be installed and running, with the granite3.3 model pulled. If you run into issues, run ollama list to verify the model name and ensure granite3.3 is installed or that your alias points to it.

shell

ollama pull granite3.3

orIf you chose to use a hosted model, edit the LLM_CHAT_MODEL_NAME in the .env file.

example

# Examples (pick one that matches your provider/account):
LLM_CHAT_MODEL_NAME="openai:gpt-5-mini"

Add your API key for your preferred provider to your .env file and uncomment the line.

example

# Examples (pick one that matches your provider/account):
OPENAI_API_KEY="YOUR API KEY"

Run the Agent

This agent is an activity planner that can help you plan your day. Prompt it with your task and location. Exit the loop by typing “q” and enter.Take a look inside the code file to understand the example agent.

uv run python beeai_framework_starter/agent.py

npm run start src/agent.ts

Congradulations! You’ve ran your first BeeAI agent.

Explore more examples in our Python and TypeScript libraries.

Introduction

Core Concepts

Integrations

Guides

Community