@open-agent-kit/core

⚠️ Note: OAK is currently in beta - expect some bugs and issues. We are working hard to fix them!

Welcome to OPEN AGENT KIT (OAK)

OAK is an extensible open source platform for building and deploying AI agents! Website: https://open-agent-kit.com

Features

• 🧠 Built-in knowledge base (upload PDFs, Word Docs, CSV, JSON, etc.)
• 🐳 Deploy anywhere (Vercel, AWS, GCP, Azure, Netlify, Digital Ocean, etc.)
• 🤖 Connect to any LLM (OpenAI, Anthropic, Google, Self-hosted, etc.)
• 🔌 Plugin Ecosystem
• 🛠️ Built-in tools
• 💬 Embeddable Chat UI (add it to your website in minutes)

Deploy with ease

More guides are available here

Build on the best open source libraries

• 🛣️ React Router
• 🎨 Shadcn UI
• 🔒 Better Auth
• 🐘 Postgres & PGVector
• ⚡ AI SDK

Join the community

• Discord

How to run locally with docker (quick start)

use this option if you want to run the app locally without any changes.

1. Get your OpenAI, Google, xAi or Anthropic API key (you can use many other models as well - go with the "advanced" option to use a different model)
2. Run the following command to start the app

npx @open-agent-kit/cli run docker

3. Open the app in your browser

http://localhost:3000

How to run locally (advanced)

use this option if you want to change the default model, install plugins, or create your own plugins.

1. Scaffold a new project

npx @open-agent-kit/cli create project

2. Set the environment variables in the .env file (use the .env.example file as a reference)
3. Run the following command to start the app

npm run dev

4. Open the app in your browser

http://localhost:5173

5. Deploy Read our deployment docs

Plugin Ecosystem

OAK is designed to be extensible with plugins. From custom knowledge providers, tools, pages, the sky is the limit! Create your own plugins or use the ones made by the community! Get started with the plugin docs

Read the docs

Docs

Contributing

We love contributions! Please read the contributing guide to get started.