README
¶
OpenAgent
Next-generation personal AI assistant powered by LLM, RAG and agent loops
Supporting computer-use, browser-use and coding agent
✨ Overview
OpenAgent is an open-source personal AI assistant that brings together powerful LLMs, your own knowledge base, and autonomous agent loops — all in one self-hostable platform. Connect any model provider, build a RAG knowledge base from your documents, and let agents browse the web, run code, and call any MCP-compatible tool on your behalf.
| 📊 Usage Analytics | 📋 Activity Monitoring |
|---|---|
 |
 |
| 🛠️ Tool Management | 🔍 Detailed Logs |
 |
 |
📝 Note: Screenshots above showcase the built-in admin dashboard.
🚀 Online Demo
| 🌐 Environment | URL | 💡 Notes |
|---|---|---|
| Live Preview | https://demo.openagentai.org | Read-only tour — no account needed |
| Playground | https://try.openagentai.org | Make changes freely — data resets every 5 minutes |
📦 Quick Start
Pre-built binaries are available for Linux, macOS, and Windows (amd64 / arm64). The install script downloads the latest release, installs it, and starts the server on port 14000.
🔧 Install Binary (Recommended)
macOS / Linux / WSL
curl -fsSL --proto '=https' --tlsv1.2 \
https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.sh | bash
Windows (PowerShell)
irm https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.ps1 | iex
Then open http://localhost:14000.
💡 Optional environment variables:
OPENAGENT_VERSION,INSTALL_DIR,BIN_DIR.
🛠️ Build from Source
# Backend
go build
# Frontend
cd web && yarn install && yarn start
🌟 Highlights
🔄 Agent Loops
| Feature | Description |
|---|---|
| 🌐 Browser-Use | Drive a real browser: navigate, click, fill forms, scrape, and screenshot pages |
| 🔎 Web Search & Fetch | Search the web and pull page content directly into the agent's context |
| 💻 Shell Execution | Run shell commands and scripts from within the agent loop |
| 📄 Office Automation | Read and write Word, Excel, and PowerPoint files |
| 🔌 MCP (Model Context Protocol) | Connect any MCP-compatible server over SSE, Stdio, or StreamableHTTP and expose its tools to the agent |
| 👁️ Transparent Tool Calls | See exactly which tool was invoked, with what arguments, and what it returned, step by step |
📚 RAG & Knowledge Base
| Feature | Description |
|---|---|
| 📤 Document Ingestion | Upload PDFs, Word docs, Excel sheets, and more; they are chunked, embedded, and indexed automatically |
| 🔍 Semantic Search | Every chat retrieves the most relevant passages from your knowledge base before the LLM responds |
| 🔗 Pluggable Embedding Providers | OpenAI, Azure, Gemini, Qwen, Cohere, Jina, HuggingFace, local models, and more |
| 🗂️ Per-Store Isolation | Organise knowledge into separate stores and assign them to individual chats or applications |
🤖 30+ Model Providers
Works out of the box with all major LLM providers — configure as many as you like and switch between them per chat:
OpenAI · Azure OpenAI · Claude (Anthropic) · Gemini (Google) · DeepSeek · Mistral · Grok · Qwen · Doubao · Moonshot · ChatGLM · Baichuan · Ernie · iFlytek · HuggingFace · Cohere · Amazon Bedrock · OpenRouter · local models · and more
⚡ Workflow Automation
| Feature | Description |
|---|---|
| 🎨 Visual Workflow Builder | Compose multi-step pipelines with a BPMN-style editor |
| 🔀 Conditional & Parallel Execution | Branch on gateway conditions and run tasks concurrently |
| ⏰ Task Scheduling | Run workflows or agent jobs on a recurring schedule |
| 📊 Usage Analytics | Track token consumption and cost per provider, model, and user |
🏗️ Platform Features
| Feature | Description |
|---|---|
| 🔐 Single Sign-On | OIDC / OAuth2 / LDAP / SAML via the integrated auth layer |
| 🏢 Multi-tenant | Separate workspaces per user or organisation |
| 🌐 REST API + Swagger UI | Every feature is accessible programmatically |
| 📋 Audit Logs | Full activity history for every action |
| 🗄️ File & Video Management | Built-in storage for files, images, and video content |
📈 Admin Dashboard
| Feature | Description |
|---|---|
| 📊 Usage Statistics | Comprehensive metrics covering applications, users, chats, messages, tokens, and estimated cost with interactive charts and heatmaps |
| 📋 Activity Monitoring | Real-time visualization of system operations with success/error tracking, operation-type pie charts, and trend analysis |
| 🛠️ Tool Management | Centralised management of all agent tools — browser-use, GUI automation, office, shell, web search, and more — with full CRUD control |
| 🔍 Detailed Request Logs | Inspect complete request/response payloads with JSON formatting, filtering, and debugging capabilities for every API call |
📖 Documentation
👉 https://www.openagentai.org/
🤝 Community
| Platform | Link |
|---|---|
| 💬 Discord | https://discord.gg/5rPsrAzK7S |
| 🐛 Issues & PRs | Welcome — please open an issue first to discuss larger changes |
📄 License
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth is a thin wrapper around the identity-provider SDK.
|
Package auth is a thin wrapper around the identity-provider SDK. |
|
internal
|
|
|
cli
Package cli handles command-line dispatch before heavy application init.
|
Package cli handles command-line dispatch before heavy application init. |
|
Package routers @APIVersion 1.70.0 @Title OpenAgent RESTful API @Description Swagger Docs of OpenAgent Backend API @Contact admin@openagentai.org @SecurityDefinition AccessToken apiKey Authorization header @Schemes https,http @ExternalDocs Find out more about OpenAgent @ExternalDocsUrl https://openagentai.org/
|
Package routers @APIVersion 1.70.0 @Title OpenAgent RESTful API @Description Swagger Docs of OpenAgent Backend API @Contact admin@openagentai.org @SecurityDefinition AccessToken apiKey Authorization header @Schemes https,http @ExternalDocs Find out more about OpenAgent @ExternalDocsUrl https://openagentai.org/ |