@samitouri / QOSami_Agents_Zero / commits / 69e17748

Update README and installation docs

Nicolas Leão committed Mar 27, 2026 at 11:19 UTC 69e177487f57384dcca78d24b5f4078d084fe826
2 files changed +52 -244
README.md
+13 -229
@@ -36,7 +36,7 @@ Or see DeepWiki generated documentation:
36
37
38
39 -[![Showcase](/docs/res/showcase-thumb.png)](https://youtu.be/lazLNcEYsiQ)
39 +[![Showcase](/docs/res/showcase-thumb.png)](https://www.youtube.com/watch?v=MdzLhWWoxEs)
40
41
42 ## A personal, organic agentic framework that grows and learns with you
@@ -53,19 +53,25 @@ Click to open a video to learn how to install Agent Zero:
53
54 [![Easy Installation guide](/docs/res/install_guide.png)](https://www.youtube.com/watch?v=2-qFNUvqrXA)
55
56 -A detailed setup guide for Windows, macOS, and Linux with a video can be found in the Agent Zero Documentation at [this page](./docs/setup/installation.md).
57 -
56 ### ⚡ Quick Start
57
58 +**macOS / Linux:**
59 ```bash
61 -# Pull and run with Docker
60 +curl -fsSL https://bash.agent-zero.ai | bash
61 +```
62
63 -docker pull agent0ai/agent-zero
64 -docker run -p 50001:80 agent0ai/agent-zero
63 +**Windows (PowerShell):**
64 +```powershell
65 +irm https://ps.agent-zero.ai | iex
66 +```
67
66 -# Visit http://localhost:50001 to start
68 +**Docker:**
69 +```bash
70 +docker run -p 80:80 agent0ai/agent-zero
71 ```
72
73 +A detailed setup guide for Windows, macOS, and Linux can be found in the Agent Zero Documentation at [this page](./docs/setup/installation.md).
74 +
75
76 # 💡 Key Features
77
@@ -172,228 +178,6 @@ docker run -p 50001:80 agent0ai/agent-zero
178 | [Troubleshooting](./docs/guides/troubleshooting.md) | Common issues and their solutions |
179
180
175 -## 🎯 Changelog
176 -
177 -GitHub release notes for the latest eligible `main` tag are generated during `.github/workflows/docker-publish.yml` from commit subjects and descriptions since the previous published release, using OpenRouter and the editable prompt in `scripts/openrouter_release_notes_system_prompt.md`.
178 -
179 -### v0.9.8 - Skills, UI Redesign & Git projects
180 -[Release video](https://youtu.be/NV7s78yn6DY)
181 -
182 -- Skills
183 - - Skills System replacing the legacy Instruments with a new `SKILL.md` standard for structured, portable agent capabilities.
184 - - Built-in skills, and UI support for importing and listing skills
185 -- Real-time WebSocket infrastructure replacing the polling-based approach for UI state synchronization
186 -- UI Redesign
187 - - Process groups to visually group agent actions with expand/collapse support
188 - - Timestamps, steps count and execution time with tool-specific badges
189 - - Step detail modals with key-value and raw JSON display
190 - - Collapsible responses with show more/less and copy buttons on code blocks and tables
191 - - Message queue system allowing users to queue messages while the agent is still processing
192 - - In-browser file editor for viewing and editing files without leaving the UI
193 - - Welcome screen redesign with info and warning banners for connection security, missing API keys, and system resources
194 - - Scheduler redesign with standalone modal, separate task list, detail and editor components, and project support
195 - - Smooth response rendering and scroll stabilization across chat, terminals, and image viewer
196 - - Chat width setting and reworked preferences panel
197 - - Image viewer improvements with scroll support and expanded viewer
198 - - Redesigned sidebar with reusable dropdown component and streamlined buttons
199 - - Inline button confirmations for critical actions
200 - - Improved login design and new logout button
201 - - File browser enhanced with rename and file actions dropdown
202 -- Git projects
203 - - Git-based projects with clone authentication for public and private repositories
204 -- Four new LLM providers: CometAPI, Z.AI, Moonshot AI, and AWS Bedrock
205 -- Microsoft Dev Tunnels integration for secure remote access
206 -- User data migration to `/usr` directory for cleaner separation of user and system files
207 -- Subagents system with configurable agent profiles for different roles
208 -- Memory operations offloaded to deferred tasks for better performance
209 -- Environment variables can now configure settings via `A0_SET_*` prefix in `.env`
210 -- Automatic migration with overwrite support for `.env`, scheduler, knowledge, and legacy directories
211 -- Projects support extended to MCP, A2A, and external API
212 -- Workdir outside project support for more flexible file organization
213 -- Agent number tracking in backend and responses for multi-agent identification
214 -- Many bug fixes and stability improvements across the UI, MCP tools, scheduler, uploads, and WebSocket handling
215 -
216 -
217 -### v0.9.7 - Projects
218 -[Release video](https://youtu.be/RrTDp_v9V1c)
219 -- Projects management
220 - - Support for custom instructions
221 - - Integration with memory, knowledge, files
222 - - Project specific secrets
223 -- New Welcome screen/Dashboard
224 -- New Wait tool
225 -- Subordinate agent configuration override support
226 -- Support for multiple documents at once in document_query_tool
227 -- Improved context on interventions
228 -- Openrouter embedding support
229 -- Frontend components refactor and polishing
230 -- SSH metadata output fix
231 -- Support for windows powershell in local TTY utility
232 -- More efficient selective streaming for LLMs
233 -- UI output length limit improvements
234 -
235 -### v0.9.6 - Memory Dashboard
236 -[Release video](https://youtu.be/sizjAq2-d9s)
237 -- Memory Management Dashboard
238 -- Kali update
239 -- Python update + dual installation
240 -- Browser Use update
241 -- New login screen
242 -- LiteLLM retry on temporary errors
243 -- Github Copilot provider support
244 -
245 -### v0.9.5 - Secrets
246 -[Release video](https://www.youtube.com/watch?v=VqxUdt7pjd8)
247 -- Secrets management - agent can use credentials without seeing them
248 -- Agent can copy paste messages and files without rewriting them
249 -- LiteLLM global configuration field
250 -- Browser agent configuration improvements
251 -- Progressive web app support
252 -- Extra model params support for JSON
253 -- Short IDs for files and memories to prevent LLM errors
254 -- Tunnel component frontend rework
255 -- Fix for timezone change bug
256 -- Notifications z-index fix
257 -
258 -### v0.9.4 - Connectivity, UI
259 -[Release video](https://www.youtube.com/watch?v=C2BAdDOduIc)
260 -- External API endpoints
261 -- Streamable HTTP MCP A0 server
262 -- A2A (Agent to Agent) protocol - server+client
263 -- New notifications system
264 -- New local terminal interface for stability
265 -- Rate limiter integration to models
266 -- Delayed memory recall
267 -- Smarter autoscrolling in UI
268 -- Action buttons in messages
269 -- Multiple API keys support
270 -- Download streaming
271 -- Tunnel URL QR code
272 -- Internal fixes and optimizations
273 -
274 -### v0.9.3 - Subordinates, memory, providers Latest
275 -[Release video](https://www.youtube.com/watch?v=-LfejFWL34k)
276 -- Faster startup/restart
277 -- Subordinate agents can have dedicated prompts, tools and system extensions
278 -- Streamable HTTP MCP server support
279 -- Memory loading enhanced by AI filter
280 -- Memory AI consolidation when saving memories
281 -- Auto memory system configuration in settings
282 -- LLM providers available are set by providers.yaml configuration file
283 -- Venice.ai LLM provider supported
284 -- Initial agent message for user + as example for LLM
285 -- Docker build support for local images
286 -- File browser fix
287 -
288 -### v0.9.2 - Kokoro TTS, Attachments
289 -[Release video](https://www.youtube.com/watch?v=sPot_CAX62I)
290 -
291 -- Kokoro text-to-speech integration
292 -- New message attachments system
293 -- Minor updates: log truncation, hyperlink targets, component examples, api cleanup
294 -
295 -### v0.9.1 - LiteLLM, UI improvements
296 -[Release video](https://youtu.be/crwr0M4Spcg)
297 -- Langchain replaced with LiteLLM
298 - - Support for reasoning models streaming
299 - - Support for more providers
300 - - Openrouter set as default instead of OpenAI
301 -- UI improvements
302 - - New message grouping system
303 - - Communication smoother and more efficient
304 - - Collapsible messages by type
305 - - Code execution tool output improved
306 - - Tables and code blocks scrollable
307 - - More space efficient on mobile
308 -- Streamable HTTP MCP servers support
309 -- LLM API URL added to models config for Azure, local and custom providers
310 -
311 -### v0.9.0 - Agent roles, backup/restore
312 -[Release video](https://www.youtube.com/watch?v=rMIe-TC6H-k)
313 -- subordinate agents can use prompt profiles for different roles
314 -- backup/restore functionality for easier upgrades
315 -- security and bug fixes
316 -
317 -### v0.8.7 - Formatting, Document RAG Latest
318 -[Release video](https://youtu.be/OQJkfofYbus)
319 -- markdown rendering in responses
320 -- live response rendering
321 -- document Q&A tool
322 -
323 -### v0.8.6 - Merge and update
324 -[Release video](https://youtu.be/l0qpK3Wt65A)
325 -- Merge with Hacking Edition
326 -- browser-use upgrade and integration re-work
327 -- tunnel provider switch
328 -
329 -### v0.8.5 - **MCP Server + Client**
330 -[Release video](https://youtu.be/pM5f4Vz3_IQ)
331 -
332 -- Agent Zero can now act as MCP Server
333 -- Agent Zero can use external MCP servers as tools
334 -
335 -### v0.8.4.1 - 2
336 -Default models set to gpt-4.1
337 -- Code execution tool improvements
338 -- Browser agent improvements
339 -- Memory improvements
340 -- Various bugfixes related to context management
341 -- Message formatting improvements
342 -- Scheduler improvements
343 -- New model provider
344 -- Input tool fix
345 -- Compatibility and stability improvements
346 -
347 -### v0.8.4
348 -[Release video](https://youtu.be/QBh_h_D_E24)
349 -
350 -- **Remote access (mobile)**
351 -
352 -### v0.8.3.1
353 -[Release video](https://youtu.be/AGNpQ3_GxFQ)
354 -
355 -- **Automatic embedding**
356 -
357 -### v0.8.3
358 -[Release video](https://youtu.be/bPIZo0poalY)
359 -
360 -- ***Planning and scheduling***
361 -
362 -### v0.8.2
363 -[Release video](https://youtu.be/xMUNynQ9x6Y)
364 -
365 -- **Multitasking in terminal**
366 -- **Chat names**
367 -
368 -### v0.8.1
369 -[Release video](https://youtu.be/quv145buW74)
370 -
371 -- **Browser Agent**
372 -- **UX Improvements**
373 -
374 -### v0.8
375 -[Release video](https://youtu.be/cHDCCSr1YRI)
376 -
377 -- **Docker Runtime**
378 -- **New Messages History and Summarization System**
379 -- **Agent Behavior Change and Management**
380 -- **Text-to-Speech (TTS) and Speech-to-Text (STT)**
381 -- **Settings Page in Web UI**
382 -- **SearXNG Integration Replacing Perplexity + DuckDuckGo**
383 -- **File Browser Functionality**
384 -- **KaTeX Math Visualization Support**
385 -- **In-chat File Attachments**
386 -
387 -### v0.7
388 -[Release video](https://youtu.be/U_Gl0NPalKA)
389 -
390 -- **Automatic Memory**
391 -- **UI Improvements**
392 -- **Instruments**
393 -- **Extensions Framework**
394 -- **Reflection Prompts**
395 -- **Bug Fixes**
396 -
181 ## 🤝 Community and Support
182
183 - [Join our Discord](https://discord.gg/B8KZKNsPpj) for live discussions or [visit our Skool Community](https://www.skool.com/agent-zero).
docs/setup/installation.md
+39 -15
@@ -1,13 +1,37 @@
1 # Installation Guide
2
3 -Click to open a video to learn how to install Agent Zero:
3 +## **Goal:** Go from zero to a first working chat with minimal setup.
4 +
5 +---
6
5 -[![Easy Installation guide](../res/install_guide.png)](https://www.youtube.com/watch?v=2-qFNUvqrXA)
7 +## Quick Start (Recommended)
8
7 -## **Goal:** Go from zero to a first working chat with minimal setup.
9 +The install script is the fastest way to get Agent Zero running. It handles Docker, image pulling, and container setup automatically.
10 +
11 +**macOS / Linux:**
12 +```bash
13 +curl -fsSL https://bash.agent-zero.ai | bash
14 +```
15 +
16 +**Windows (PowerShell):**
17 +```powershell
18 +irm https://ps.agent-zero.ai | iex
19 +```
20 +
21 +**Docker (run directly):**
22 +```bash
23 +docker run -p 80:80 agent0ai/agent-zero
24 +```
25 +
26 +Once the install completes, open the URL shown in your terminal to access the Web UI and proceed to [Step 3: Configure Agent Zero](#step-3-configure-agent-zero).
27 +
28 +---
29 +
30 +## Manual Docker Setup
31
32 +If you prefer to set things up manually, follow the steps below.
33
10 -## Step 1: Install Docker Desktop
34 +### Step 1: Install Docker Desktop
35
36 Docker Desktop provides the runtime environment for Agent Zero, ensuring consistent behavior and security across platforms. The entire framework runs within a Docker container, providing isolation and easy deployment.
37
@@ -39,7 +63,7 @@ Docker Desktop provides the runtime environment for Agent Zero, ensuring consist
63 ---
64
65 <a name="windows-installation"></a>
42 -## <img src="../res/setup/oses/windows.png" width="30" alt="Windows"/> Windows Installation
66 +#### <img src="../res/setup/oses/windows.png" width="30" alt="Windows"/> Windows Installation
67
68 **1.1. Download Docker Desktop**
69
@@ -64,12 +88,12 @@ Once installed, launch Docker Desktop from your Start menu or desktop shortcut.
88
89 ✅ **Docker is now installed!**
90
67 -### Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)
91 +Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)
92
93 ---
94
95 <a name="macos-installation"></a>
72 -## <img src="../res/setup/oses/apple.png" width="30" alt="macOS"/> macOS Installation
96 +#### <img src="../res/setup/oses/apple.png" width="30" alt="macOS"/> macOS Installation
97
98 **1.1. Download Docker Desktop**
99
@@ -101,12 +125,12 @@ Open Docker Desktop from your Applications folder.
125
126 ✅ **Docker is now installed!**
127
104 -### Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)
128 +Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)
129
130 ---
131
132 <a name="linux-installation"></a>
109 -## <img src="../res/setup/oses/linux.png" width="30" alt="Linux"/> Linux Installation
133 +#### <img src="../res/setup/oses/linux.png" width="30" alt="Linux"/> Linux Installation
134
135 **1.1. Choose Installation Method**
136
@@ -145,9 +169,9 @@ If you installed Docker Desktop, launch it from your applications menu.
169
170 ---
171
148 -## Step 2: Run Agent Zero
172 +### Step 2: Run Agent Zero
173
150 -### 2.1. Pull the Agent Zero Docker Image
174 +#### 2.1. Pull the Agent Zero Docker Image
175
176 **Using Docker Desktop GUI:**
177
@@ -163,11 +187,11 @@ If you installed Docker Desktop, launch it from your applications menu.
187 docker pull agent0ai/agent-zero
188 ```
189
166 -### 2.2. (Optional) Map Folders for Persistence
190 +#### 2.2. (Optional) Map Folders for Persistence
191
192 Choose or create a folder on your computer where Agent Zero will save its data.
193
170 -### Setting up persistence is needed only if you want your data and files to remain available even after you delete the container.
194 +Setting up persistence is needed only if you want your data and files to remain available even after you delete the container.
195
196 You can pick any location you find convenient:
197
@@ -182,7 +206,7 @@ You can map just the `/a0/usr` directory (recommended) or individual subfolders
206 > [!TIP]
207 > Choose a location that's easy to access and backup. All your Agent Zero data will be directly accessible in this directory.
208
185 -### 2.3. Run the Container
209 +#### 2.3. Run the Container
210
211 **Using Docker Desktop GUI:**
212
@@ -199,7 +223,7 @@ The container will start and show in the "Containers" tab:
223
224 ![docker containers](../res/setup/4-docker-container-started.png)
225
202 -### 2.4. Access the Web UI
226 +#### 2.4. Access the Web UI
227
228 The framework will take a few seconds to initialize. Find the mapped port in Docker Desktop (shown as `<PORT>:80`) or click the port right under the container ID:
229