File: README.md
English | 中文
What is OpenAgent?
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.
Quick Start
Pre-built binaries for Linux, macOS, and Windows (x86_64 / arm64). The installer downloads the latest release and starts OpenAgent on port 14000.
macOS / Linux / WSL
curl -fsSL https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.sh | bashWindows (PowerShell)
irm https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.ps1 | iexWindows runs natively — no WSL, no Docker required.
Open http://localhost:14000 and you're in.
Optional env vars:
OPENAGENT_VERSION,INSTALL_DIR,BIN_DIR
Build from source
Prerequisites:
# Backend
go build
# Frontend
cd web && yarn install && yarn startDocker
docker-compose upOpen http://localhost:14000 once the containers are running.
Features
🤖 30+ Model Providers
Connect every major LLM provider and switch between them per conversation — no code changes required.
🔄 Autonomous Agent Loops
| Capability | Description |
|---|---|
| Browser-Use | Drive a real browser — navigate, click, fill forms, scrape, and screenshot pages |
| Web Search & Fetch | Search the web and pull live page content into the agent's context |
| Shell Execution | Run shell commands and scripts directly from the agent loop |
| Office Automation | Read and write Word, Excel, and PowerPoint files |
| MCP Integration | Plug in any MCP-compatible server (SSE / Stdio / StreamableHTTP) and expose its tools to the agent |
| Transparent Tool Calls | See every tool invocation, its arguments, and its return value — step by step |
📚 RAG & Knowledge Base
| Capability | Description |
|---|---|
| Document Ingestion | Upload PDFs, Word docs, Excel sheets, and more — chunked, embedded, and indexed automatically |
| Semantic Search | Retrieves the most relevant passages from your knowledge base before each LLM response |
| Pluggable Embeddings | OpenAI, Azure, Gemini, Qwen, Cohere, Jina, HuggingFace, local models, and more |
| Isolated Stores | Organise knowledge into separate stores; assign them per chat or per application |
⚡ Workflow Automation
| Capability | Description |
|---|---|
| Visual Workflow Builder | Compose multi-step pipelines with a BPMN-style drag-and-drop editor |
| Conditional & Parallel Execution | Branch on gateway conditions; run independent tasks concurrently |
| Task Scheduling | Trigger workflows or agent jobs on a recurring schedule |
| Usage Analytics | Track token consumption and cost per provider, model, and user |
🏗️ Platform Features
| Capability | Description |
|---|---|
| Single Binary | One executable file — no installer, no runtime dependencies. Download and run instantly on any supported platform |
| Native Windows Support | Runs directly on Windows — no WSL, no Docker, no Linux subsystem required |
| Single Sign-On | OIDC / OAuth2 / LDAP / SAML via the built-in auth layer |
| Multi-tenancy | Isolated workspaces per user or organisation |
| REST API + Swagger UI | Every feature is accessible programmatically |
| Audit Logs | Full activity history for every action |
| File & Media Management | Built-in storage for files, images, and video content |
📊 Admin Dashboard
| Panel | What you get |
|---|---|
| Usage Statistics | Token & cost metrics per app, user, and model — with interactive charts and heatmaps |
| Activity Monitoring | Real-time system operations with success/error rates, operation-type breakdowns, and trends |
| Tool Management | Centralised CRUD for all agent tools: browser, shell, office, web search, and more |
| Request Logs | Full request/response payloads with JSON formatting, filtering, and debugging |
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 |
Documentation
Full docs at https://www.openagentai.org
Community
- Discord — discord.gg/5rPsrAzK7S · chat with maintainers and other users
- Issues & PRs — welcome! Please open an issue first to discuss larger changes
License
File: web/README.md
Getting Started with Create React App
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
`npm start`
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
`npm test`
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
`npm run build`
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
`npm run eject`
Note: this is a one-way operation. Once you eject, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
Learn More
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
`npm run build` fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify