Skip to content

Commit eefeaf1

Browse files
committed
Update README with non-obvious advantages and concrete features
Replace generic "Why ConnectOnion?" table with detailed sections covering: built-in AI programmer, frontend/backend, tool ecosystem, approval system, skills system, lifecycle hooks, and multi-agent trust system.
1 parent be507d7 commit eefeaf1

1 file changed

Lines changed: 95 additions & 30 deletions

File tree

README.md

Lines changed: 95 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -70,48 +70,113 @@ host(agent) # HTTP server + P2P relay - other agents can now discover and call
7070

7171
## ✨ Why ConnectOnion?
7272

73-
<table>
74-
<tr>
75-
<td width="33%">
73+
Most frameworks give you a way to call LLMs. ConnectOnion gives you everything around it — so you only write prompt and tools.
7674

77-
### 🎯 **Simple API**
78-
Just one `Agent` class. Your functions become tools automatically. Start in 2 lines, not 200.
75+
### Built-in AI Programmer
7976

80-
</td>
81-
<td width="33%">
77+
```bash
78+
co ai # Opens a chat interface with an AI that deeply understands ConnectOnion
79+
```
80+
81+
`co ai` is an AI coding assistant built *with* ConnectOnion. It writes working agent code because it knows the framework inside out. Fully open-source — inspect it, modify it, build your own.
82+
83+
### Built-in Frontend & Backend — Just Write Prompt and Tools
84+
85+
Traditional path: write agent logic → build FastAPI backend → build React frontend → wire APIs → deploy.
86+
87+
ConnectOnion path: **write prompt and tools → deploy.**
88+
89+
- Backend: framework handles the API layer
90+
- Frontend: [chat.openonion.ai](https://chat.openonion.ai) — ready-to-use chat interface
91+
- All open-source, customizable, but you don't start from zero
92+
93+
### Ready-to-Use Tool Ecosystem
94+
95+
Import and use — no schema writing, no interface wiring:
96+
97+
```python
98+
from connectonion import bash, Shell # Command execution
99+
from connectonion.useful_tools import FileTools # File system (with safety tracking)
100+
from connectonion.useful_tools.browser_tools import BrowserAutomation # Natural language browser automation
82101

83-
### 🚀 **Production Ready**
84-
Battle-tested with GPT-5, Gemini 2.5, Claude Opus 4.1. Logging, debugging, trust system built-in.
102+
from connectonion import Gmail, Outlook # Email
103+
from connectonion import GoogleCalendar # Calendar
104+
from connectonion import Memory # Persistent memory
105+
from connectonion import TodoList # Task tracking
106+
```
107+
108+
Need to customize? Copy the source into your project:
85109

86-
</td>
87-
<td width="33%">
110+
```bash
111+
co copy Gmail # Copies Gmail tool source code to your project for modification
112+
```
88113

89-
### 🌍 **Open Source**
90-
MIT licensed. Community-driven. Join 1000+ developers building the future of AI agents.
114+
### Built-in Approval System
91115

92-
</td>
93-
</tr>
94-
<tr>
95-
<td width="33%">
116+
Dangerous operations (bash commands, file deletion) automatically trigger approval — no permission logic needed from you.
96117

97-
### 🔌 **Plugin System**
98-
Add reflection & reasoning to any agent in one line. Extensible and composable.
118+
```python
119+
from connectonion.useful_plugins import tool_approval, shell_approval
99120

100-
</td>
101-
<td width="33%">
121+
agent = Agent("assistant", tools=[bash], plugins=[shell_approval])
122+
# Shell commands now require approval before execution
123+
```
102124

103-
### 🔍 **Interactive Debugging**
104-
Pause at breakpoints with `@xray`, inspect state, modify variables on-the-fly.
125+
Plugin-based: turn it off, customize it, or replace it entirely.
105126

106-
</td>
107-
<td width="33%">
127+
### Skills System — Auto-Discovery, Claude Code Compatible
108128

109-
### **No Boilerplate**
110-
Scale from prototypes to production systems without rewriting code.
129+
Reusable workflows with automatic permission scoping:
130+
131+
```python
132+
from connectonion.useful_plugins import skills
133+
134+
agent = Agent("assistant", tools=[file_tools], plugins=[skills])
135+
136+
# User types /commit → skill loads → git commands auto-approved → permission cleared after execution
137+
```
138+
139+
Three-level auto-discovery (project → user → built-in):
140+
```
141+
.co/skills/skill-name/SKILL.md # Project-level (highest priority)
142+
~/.co/skills/skill-name/SKILL.md # User-level
143+
builtin/skill-name/SKILL.md # Built-in
144+
```
145+
146+
Automatically loads Claude Code skills from `.claude/skills/` — no conversion needed.
147+
148+
### 12 Lifecycle Hooks + Plugin System
149+
150+
Inject logic at any point in the agent execution cycle:
151+
152+
```python
153+
from connectonion import Agent, after_tools, llm_do
154+
from connectonion.useful_plugins import re_act, eval, auto_compact, subagents
155+
156+
# Built-in plugins — same capabilities as Claude Code, open to any agent
157+
agent = Agent("researcher", tools=[search], plugins=[
158+
re_act, # Reflect + plan after each tool call
159+
auto_compact, # Auto-compress context at 90% capacity
160+
subagents, # Spawn sub-agents with independent tools and prompts
161+
])
162+
```
163+
164+
Hooks: `after_user_input`, `before_iteration`, `before_llm`, `after_llm`, `before_tools`, `before_each_tool`, `after_each_tool`, `after_tools`, `on_error`, `after_iteration`, `on_stop_signal`, `on_complete`
165+
166+
Plugins are just lists of event handlers — visible, modifiable, `co copy`-able.
167+
168+
### Multi-Agent Trust System (Fast Rules)
169+
170+
When agents call each other, trust decisions happen **before LLM involvement** — zero token cost for 90% of cases:
171+
172+
```python
173+
agent = Agent(
174+
name="production",
175+
trust="careful" # whitelist → allow, unknown → ask LLM, blocked → deny
176+
)
177+
```
111178

112-
</td>
113-
</tr>
114-
</table>
179+
Three presets: `open` (dev), `careful` (staging), `strict` (production).
115180

116181
---
117182

0 commit comments

Comments
 (0)