Skip to content

Commit 63674fe

Browse files
hsluoyzhsluoyz
committed
fix: improve README, fix go linter
1 parent 08dbaf0 commit 63674fe

2 files changed

Lines changed: 121 additions & 117 deletions

File tree

‎README.md‎

Lines changed: 103 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,68 @@
11
<div align="center">
22

3-
<img src="https://raw.githubusercontent.com/the-open-agent/static/master/img/openagent-logo_1600x276.png" alt="OpenAgent Logo" width="400">
4-
5-
<h1>OpenAgent</h1>
6-
7-
<p><strong>Next-generation personal AI assistant powered by LLM, RAG and agent loops</strong><br>
8-
<em>Supporting computer-use, browser-use and coding agent</em></p>
9-
10-
<p>
11-
<a href="https://github.com/the-open-agent/openagent/actions/workflows/build.yml">
12-
<img alt="Build" src="https://github.com/the-open-agent/openagent/workflows/Build/badge.svg?style=flat-square">
13-
</a>
14-
<a href="https://github.com/the-open-agent/openagent/releases/latest">
15-
<img alt="Release" src="https://img.shields.io/github/v/release/the-open-agent/openagent.svg">
16-
</a>
17-
<a href="https://hub.docker.com/r/casbin/openagent">
18-
<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/casbin/openagent.svg">
19-
</a>
20-
<a href="https://goreportcard.com/report/github.com/the-open-agent/openagent">
21-
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/the-open-agent/openagent?style=flat-square">
22-
</a>
23-
<a href="https://github.com/the-open-agent/openagent/blob/master/LICENSE">
24-
<img alt="License" src="https://img.shields.io/github/license/the-open-agent/openagent?style=flat-square">
25-
</a>
26-
<a href="https://discord.gg/5rPsrAzK7S">
27-
<img alt="Discord" src="https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2">
28-
</a>
29-
</p>
3+
<img src="https://cdn.openagentai.org/img/openagent-logo_1900x450.png" alt="OpenAgent" width="480">
4+
5+
<br/>
6+
<br/>
7+
8+
**Next-generation personal AI assistant powered by LLM, RAG and agent loops**
9+
10+
*Supporting computer-use, browser-use and coding agent*
11+
12+
<br/>
13+
14+
[![Build](https://github.com/the-open-agent/openagent/workflows/Build/badge.svg?style=flat-square)](https://github.com/the-open-agent/openagent/actions/workflows/build.yml)
15+
[![Release](https://img.shields.io/github/v/release/the-open-agent/openagent?style=flat-square&color=4f46e5)](https://github.com/the-open-agent/openagent/releases/latest)
16+
[![Docker Pulls](https://img.shields.io/docker/pulls/casbin/openagent?style=flat-square&color=0ea5e9)](https://hub.docker.com/r/casbin/openagent)
17+
[![Go Report](https://goreportcard.com/badge/github.com/the-open-agent/openagent?style=flat-square)](https://goreportcard.com/report/github.com/the-open-agent/openagent)
18+
[![License](https://img.shields.io/github/license/the-open-agent/openagent?style=flat-square&color=22c55e)](https://github.com/the-open-agent/openagent/blob/master/LICENSE)
19+
[![Discord](https://img.shields.io/discord/1022748306096537660?logo=discord&label=discord&color=5865F2&style=flat-square)](https://discord.gg/5rPsrAzK7S)
20+
21+
<br/>
22+
23+
[**Live Demo**](https://demo.openagentai.org) · [**Playground**](https://try.openagentai.org) · [**Docs**](https://www.openagentai.org) · [**Discord**](https://discord.gg/5rPsrAzK7S)
3024

3125
</div>
3226

3327
---
3428

35-
## ✨ Overview
29+
## What is OpenAgent?
3630

3731
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.
3832

3933
<div align="center">
34+
<br/>
4035

41-
| 📊 Usage Analytics | 📋 Activity Monitoring |
36+
| Usage Analytics | Activity Monitoring |
4237
|:---:|:---:|
4338
| ![Usage Analytics](https://raw.githubusercontent.com/the-open-agent/static/master/img/screenshot-usages.png) | ![Activity Monitoring](https://raw.githubusercontent.com/the-open-agent/static/master/img/screenshot-activities.png) |
44-
| 🛠️ Tool Management | 🔍 Detailed Logs |
39+
| **Tool Management** | **Detailed Logs** |
4540
| ![Tool Management](https://raw.githubusercontent.com/the-open-agent/static/master/img/screenshot-tools.png) | ![Detailed Logs](https://raw.githubusercontent.com/the-open-agent/static/master/img/screenshot-logs.png) |
4641

42+
<br/>
4743
</div>
4844

49-
> 📝 **Note:** Screenshots above showcase the built-in admin dashboard.
50-
5145
---
5246

53-
## 🚀 Online Demo
54-
55-
| 🌐 Environment | URL | 💡 Notes |
56-
|:---|:---|:---|
57-
| **Live Preview** | https://demo.openagentai.org | Read-only tour — no account needed |
58-
| **Playground** | https://try.openagentai.org | Make changes freely — data resets every 5 minutes |
47+
## Quick Start
5948

60-
---
61-
62-
## 📦 Quick Start
63-
64-
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**.
65-
66-
### 🔧 Install Binary (Recommended)
49+
Pre-built binaries for **Linux**, **macOS**, and **Windows** (`amd64` / `arm64`). The installer downloads the latest release and starts OpenAgent on **port 14000**.
6750

6851
**macOS / Linux / WSL**
69-
7052
```bash
7153
curl -fsSL https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.sh | bash
7254
```
7355

7456
**Windows (PowerShell)**
75-
7657
```powershell
7758
irm https://raw.githubusercontent.com/the-open-agent/openagent/master/scripts/install.ps1 | iex
7859
```
7960

80-
Then open [http://localhost:14000](http://localhost:14000).
81-
82-
> 💡 Optional environment variables: `OPENAGENT_VERSION`, `INSTALL_DIR`, `BIN_DIR`.
61+
Open [http://localhost:14000](http://localhost:14000) and you're in.
8362

84-
### 🛠️ Build from Source
63+
> Optional env vars: `OPENAGENT_VERSION`, `INSTALL_DIR`, `BIN_DIR`
8564
65+
**Build from source**
8666
```bash
8767
# Backend
8868
go build
@@ -91,83 +71,107 @@ go build
9171
cd web && yarn install && yarn start
9272
```
9373

74+
**Docker**
75+
```bash
76+
docker-compose up
77+
```
78+
9479
---
9580

96-
## 🌟 Highlights
81+
## Features
9782

98-
### 🔄 Agent Loops
83+
### 🤖 30+ Model Providers
9984

100-
| Feature | Description |
101-
|:---|:---|
102-
| 🌐 **Browser-Use** | Drive a real browser: navigate, click, fill forms, scrape, and screenshot pages |
103-
| 🔎 **Web Search & Fetch** | Search the web and pull page content directly into the agent's context |
104-
| 💻 **Shell Execution** | Run shell commands and scripts from within the agent loop |
105-
| 📄 **Office Automation** | Read and write Word, Excel, and PowerPoint files |
106-
| 🔌 **MCP (Model Context Protocol)** | Connect any MCP-compatible server over SSE, Stdio, or StreamableHTTP and expose its tools to the agent |
107-
| 👁️ **Transparent Tool Calls** | See exactly which tool was invoked, with what arguments, and what it returned, step by step |
85+
Connect every major LLM provider and switch between them per conversation — no code changes required.
10886

109-
### 📚 RAG & Knowledge Base
87+
<div align="center">
88+
89+
`OpenAI` · `Azure OpenAI` · `Anthropic Claude` · `Google Gemini` · `DeepSeek` · `Mistral` · `Grok` · `Qwen` · `Doubao` · `Moonshot` · `ChatGLM` · `Baichuan` · `Ernie` · `iFlytek` · `HuggingFace` · `Cohere` · `Amazon Bedrock` · `OpenRouter` · `Ollama` · `and more`
90+
91+
</div>
92+
93+
---
94+
95+
### 🔄 Autonomous Agent Loops
11096

111-
| Feature | Description |
97+
| Capability | Description |
11298
|:---|:---|
113-
| 📤 **Document Ingestion** | Upload PDFs, Word docs, Excel sheets, and more; they are chunked, embedded, and indexed automatically |
114-
| 🔍 **Semantic Search** | Every chat retrieves the most relevant passages from your knowledge base before the LLM responds |
115-
| 🔗 **Pluggable Embedding Providers** | OpenAI, Azure, Gemini, Qwen, Cohere, Jina, HuggingFace, local models, and more |
116-
| 🗂️ **Per-Store Isolation** | Organise knowledge into separate stores and assign them to individual chats or applications |
99+
| **Browser-Use** | Drive a real browser — navigate, click, fill forms, scrape, and screenshot pages |
100+
| **Web Search & Fetch** | Search the web and pull live page content into the agent's context |
101+
| **Shell Execution** | Run shell commands and scripts directly from the agent loop |
102+
| **Office Automation** | Read and write Word, Excel, and PowerPoint files |
103+
| **MCP Integration** | Plug in any MCP-compatible server (SSE / Stdio / StreamableHTTP) and expose its tools to the agent |
104+
| **Transparent Tool Calls** | See every tool invocation, its arguments, and its return value — step by step |
117105

118-
### 🤖 30+ Model Providers
106+
---
107+
108+
### 📚 RAG & Knowledge Base
119109

120-
Works out of the box with all major LLM providers — configure as many as you like and switch between them per chat:
110+
| Capability | Description |
111+
|:---|:---|
112+
| **Document Ingestion** | Upload PDFs, Word docs, Excel sheets, and more — chunked, embedded, and indexed automatically |
113+
| **Semantic Search** | Retrieves the most relevant passages from your knowledge base before each LLM response |
114+
| **Pluggable Embeddings** | OpenAI, Azure, Gemini, Qwen, Cohere, Jina, HuggingFace, local models, and more |
115+
| **Isolated Stores** | Organise knowledge into separate stores; assign them per chat or per application |
121116

122-
<p align="center">
123-
<code>OpenAI</code> · <code>Azure OpenAI</code> · <code>Claude (Anthropic)</code> · <code>Gemini (Google)</code> · <code>DeepSeek</code> · <code>Mistral</code> · <code>Grok</code> · <code>Qwen</code> · <code>Doubao</code> · <code>Moonshot</code> · <code>ChatGLM</code> · <code>Baichuan</code> · <code>Ernie</code> · <code>iFlytek</code> · <code>HuggingFace</code> · <code>Cohere</code> · <code>Amazon Bedrock</code> · <code>OpenRouter</code> · <code>local models</code> · <code>and more</code>
124-
</p>
117+
---
125118

126119
### ⚡ Workflow Automation
127120

128-
| Feature | Description |
121+
| Capability | Description |
129122
|:---|:---|
130-
| 🎨 **Visual Workflow Builder** | Compose multi-step pipelines with a BPMN-style editor |
131-
| 🔀 **Conditional & Parallel Execution** | Branch on gateway conditions and run tasks concurrently |
132-
| ⏰ **Task Scheduling** | Run workflows or agent jobs on a recurring schedule |
133-
| 📊 **Usage Analytics** | Track token consumption and cost per provider, model, and user |
123+
| **Visual Workflow Builder** | Compose multi-step pipelines with a BPMN-style drag-and-drop editor |
124+
| **Conditional & Parallel Execution** | Branch on gateway conditions; run independent tasks concurrently |
125+
| **Task Scheduling** | Trigger workflows or agent jobs on a recurring schedule |
126+
| **Usage Analytics** | Track token consumption and cost per provider, model, and user |
134127

135-
### 🏗️ Platform Features
128+
---
129+
130+
### 🏗️ Enterprise Platform
136131

137-
| Feature | Description |
132+
| Capability | Description |
138133
|:---|:---|
139-
| 🔐 **Single Sign-On** | OIDC / OAuth2 / LDAP / SAML via the integrated auth layer |
140-
| 🏢 **Multi-tenant** | Separate workspaces per user or organisation |
141-
| 🌐 **REST API + Swagger UI** | Every feature is accessible programmatically |
142-
| 📋 **Audit Logs** | Full activity history for every action |
143-
| 🗄️ **File & Video Management** | Built-in storage for files, images, and video content |
134+
| **Single Sign-On** | OIDC / OAuth2 / LDAP / SAML via the integrated Casdoor auth layer |
135+
| **Multi-tenancy** | Isolated workspaces per user or organisation |
136+
| **REST API + Swagger UI** | Every feature is accessible programmatically |
137+
| **Audit Logs** | Full activity history for every action |
138+
| **File & Media Management** | Built-in storage for files, images, and video content |
139+
140+
---
144141

145-
### 📈 Admin Dashboard
142+
### 📊 Admin Dashboard
146143

147-
| Feature | Description |
144+
| Panel | What you get |
148145
|:---|:---|
149-
| 📊 **Usage Statistics** | Comprehensive metrics covering applications, users, chats, messages, tokens, and estimated cost with interactive charts and heatmaps |
150-
| 📋 **Activity Monitoring** | Real-time visualization of system operations with success/error tracking, operation-type pie charts, and trend analysis |
151-
| 🛠️ **Tool Management** | Centralised management of all agent tools — browser-use, GUI automation, office, shell, web search, and more — with full CRUD control |
152-
| 🔍 **Detailed Request Logs** | Inspect complete request/response payloads with JSON formatting, filtering, and debugging capabilities for every API call |
146+
| **Usage Statistics** | Token & cost metrics per app, user, and model — with interactive charts and heatmaps |
147+
| **Activity Monitoring** | Real-time system operations with success/error rates, operation-type breakdowns, and trends |
148+
| **Tool Management** | Centralised CRUD for all agent tools: browser, shell, office, web search, and more |
149+
| **Request Logs** | Full request/response payloads with JSON formatting, filtering, and debugging |
150+
151+
---
152+
153+
## Online Demo
154+
155+
| Environment | URL | Notes |
156+
|:---|:---|:---|
157+
| **Live Preview** | https://demo.openagentai.org | Read-only tour — no account needed |
158+
| **Playground** | https://try.openagentai.org | Make changes freely — data resets every 5 minutes |
153159

154160
---
155161

156-
## 📖 Documentation
162+
## Documentation
157163

158-
👉 [https://www.openagentai.org/](https://www.openagentai.org/)
164+
Full docs at **[https://www.openagentai.org](https://www.openagentai.org)**
159165

160166
---
161167

162-
## 🤝 Community
168+
## Community
163169

164-
| Platform | Link |
165-
|:---|:---|
166-
| 💬 Discord | [https://discord.gg/5rPsrAzK7S](https://discord.gg/5rPsrAzK7S) |
167-
| 🐛 Issues & PRs | Welcome — please open an issue first to discuss larger changes |
170+
- **Discord** — [discord.gg/5rPsrAzK7S](https://discord.gg/5rPsrAzK7S) · chat with maintainers and other users
171+
- **Issues & PRs** — welcome! Please open an issue first to discuss larger changes
168172

169173
---
170174

171-
## 📄 License
175+
## License
172176

173-
[Apache-2.0](https://github.com/the-open-agent/openagent/blob/master/LICENSE)
177+
[Apache 2.0](https://github.com/the-open-agent/openagent/blob/master/LICENSE)

‎object/chat.go‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,24 @@ type Chat struct {
2727
CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
2828
UpdatedTime string `xorm:"varchar(100)" json:"updatedTime"`
2929

30-
Organization string `xorm:"varchar(100)" json:"organization"`
31-
DisplayName string `xorm:"varchar(100)" json:"displayName"`
32-
Store string `xorm:"varchar(100)" json:"store"`
33-
ModelProvider string `xorm:"varchar(100)" json:"modelProvider"`
34-
Tool string `xorm:"varchar(100)" json:"tool"`
35-
Category string `xorm:"varchar(100)" json:"category"`
36-
User string `xorm:"varchar(100) index" json:"user"`
37-
ClientIp string `xorm:"varchar(100)" json:"clientIp"`
38-
UserAgent string `xorm:"varchar(200)" json:"userAgent"`
39-
ClientIpDesc string `xorm:"varchar(100)" json:"clientIpDesc"`
40-
UserAgentDesc string `xorm:"varchar(100)" json:"userAgentDesc"`
41-
MessageCount int `json:"messageCount"`
42-
TokenCount int `json:"tokenCount"`
43-
Price float64 `json:"price"`
44-
Currency string `xorm:"varchar(100)" json:"currency"`
45-
IsHidden bool `json:"isHidden"`
46-
IsDeleted bool `json:"isDeleted"`
47-
NeedTitle bool `json:"needTitle"`
30+
Organization string `xorm:"varchar(100)" json:"organization"`
31+
DisplayName string `xorm:"varchar(100)" json:"displayName"`
32+
Store string `xorm:"varchar(100)" json:"store"`
33+
ModelProvider string `xorm:"varchar(100)" json:"modelProvider"`
34+
Tool string `xorm:"varchar(100)" json:"tool"`
35+
Category string `xorm:"varchar(100)" json:"category"`
36+
User string `xorm:"varchar(100) index" json:"user"`
37+
ClientIp string `xorm:"varchar(100)" json:"clientIp"`
38+
UserAgent string `xorm:"varchar(200)" json:"userAgent"`
39+
ClientIpDesc string `xorm:"varchar(100)" json:"clientIpDesc"`
40+
UserAgentDesc string `xorm:"varchar(100)" json:"userAgentDesc"`
41+
MessageCount int `json:"messageCount"`
42+
TokenCount int `json:"tokenCount"`
43+
Price float64 `json:"price"`
44+
Currency string `xorm:"varchar(100)" json:"currency"`
45+
IsHidden bool `json:"isHidden"`
46+
IsDeleted bool `json:"isDeleted"`
47+
NeedTitle bool `json:"needTitle"`
4848
}
4949

5050
func GetGlobalChats() ([]*Chat, error) {

0 commit comments

Comments
 (0)