From 1bf5e12dbda20e8b543968fd7f77b1b64e5a7a1f Mon Sep 17 00:00:00 2001 From: David McKay Date: Tue, 18 Aug 2026 09:11:54 -0700 Subject: [PATCH] Say what OpenBot is, and point at the page about it The README opened on what a Bot gets without ever saying what the thing is: a platform that runs in your own infrastructure, with your database, your model credential and three teammates that are configuration rather than code. It also never explained that a Bot is any AG-UI endpoint, which is the reason it works with agents nobody here wrote. Links copilotkit.ai/openbot from the header and the documentation list. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b7f6bb2..ea851dc9 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Give an agent a computer of its own: a browser, a filesystem and the tools you grant it, with every action decided before it happens and recorded after.** -[**Quick start**](#quick-start) · [**Main surfaces**](#main-surfaces) · [**Features**](#features) · [**Bring your own agent**](#bring-your-own-agent) · [**Architecture**](#architecture) · [**Docs**](docs/README.md) +[**copilotkit.ai/openbot**](https://copilotkit.ai/openbot) · [**Quick start**](#quick-start) · [**Features**](#features) · [**Bring your own agent**](#bring-your-own-agent) · [**Architecture**](#architecture) · [**Docs**](docs/README.md) [![CI](https://github.com/CopilotKit/openbot/actions/workflows/ci.yml/badge.svg)](https://github.com/CopilotKit/openbot/actions/workflows/ci.yml) [![security](https://github.com/CopilotKit/openbot/actions/workflows/security_zizmor.yml/badge.svg)](https://github.com/CopilotKit/openbot/actions/workflows/security_zizmor.yml) @@ -32,6 +32,20 @@ keep the boundaries where they belong. > **Runs on your machine.** Everything below is written for a laptop. Out of the box OpenBot runs with `OPENBOT_DEV_NO_AUTH`, which skips signing in and admits every request as one administrator. [Google sign-in](#sign-in-with-google) can be wired up instead. +## What it is + +An agent platform that runs inside your own infrastructure. Docker Compose brings up every part of it, the data sits in your PostgreSQL, and the model is yours to choose: no model ships in the box, and an administrator supplies the credential, which is encrypted at rest and never logged. + +Three teammates ship in the example package, and they are configuration rather than code: **General Assistant** for everyday work, **Knowledge** for company questions, **Risk Analyst** for risk and compliance. Add your own by editing `agents.yaml` or from `/agents` in the UI. + +Anything a Bot does to a computer, a file, an MCP server or a component goes through one gateway that decides and records it. That is the difference between an agent that can use your tools and an agent you can let near them. + +More at [copilotkit.ai/openbot](https://copilotkit.ai/openbot). + +## Built on AG-UI + +A Bot is any endpoint speaking [AG-UI](https://github.com/ag-ui-protocol/ag-ui), the open protocol for agent-to-user interaction, so OpenBot is not tied to a framework and neither are you. Agents built with LangGraph, Mastra, CrewAI, Pydantic AI, Google ADK or written by hand all arrive the same way, and the governance rides the protocol rather than the framework. + ## Requirements - Docker, for PostgreSQL, browser computers, the supervisor, and the shipped Bots. @@ -237,6 +251,7 @@ Use `bash scripts/start.sh` for the whole stack. Use `bun run dev` only when you ## Documentation +- [copilotkit.ai/openbot](https://copilotkit.ai/openbot) - [docs/README.md](docs/README.md) - [docs/architecture.md](docs/architecture.md) - [docs/configuration.md](docs/configuration.md)