Agent Zero AI framework
Update README and installation docs
Nicolas Leão69e177487f57
diff --git a/README.md b/README.mdindex 46f7039ac..d9ecdedae 100644--- a/README.md+++ b/README.md@@ -36,7 +36,7 @@ Or see DeepWiki generated documentation:-[](https://youtu.be/lazLNcEYsiQ)+[](https://www.youtube.com/watch?v=MdzLhWWoxEs)## 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:[](https://www.youtube.com/watch?v=2-qFNUvqrXA)-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).-### ⚡ Quick Start+**macOS / Linux:**```bash-# Pull and run with Docker+curl -fsSL https://bash.agent-zero.ai | bash+```-docker pull agent0ai/agent-zero-docker run -p 50001:80 agent0ai/agent-zero+**Windows (PowerShell):**+```powershell+irm https://ps.agent-zero.ai | iex+```-# Visit http://localhost:50001 to start+**Docker:**+```bash+docker run -p 80:80 agent0ai/agent-zero```+A detailed setup guide for Windows, macOS, and Linux can be found in the Agent Zero Documentation at [this page](./docs/setup/installation.md).+# 💡 Key Features@@ -172,228 +178,6 @@ docker run -p 50001:80 agent0ai/agent-zero| [Troubleshooting](./docs/guides/troubleshooting.md) | Common issues and their solutions |-## 🎯 Changelog--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`.--### v0.9.8 - Skills, UI Redesign & Git projects-[Release video](https://youtu.be/NV7s78yn6DY)--- Skills- - Skills System replacing the legacy Instruments with a new `SKILL.md` standard for structured, portable agent capabilities.- - Built-in skills, and UI support for importing and listing skills-- Real-time WebSocket infrastructure replacing the polling-based approach for UI state synchronization-- UI Redesign- - Process groups to visually group agent actions with expand/collapse support- - Timestamps, steps count and execution time with tool-specific badges- - Step detail modals with key-value and raw JSON display- - Collapsible responses with show more/less and copy buttons on code blocks and tables- - Message queue system allowing users to queue messages while the agent is still processing- - In-browser file editor for viewing and editing files without leaving the UI- - Welcome screen redesign with info and warning banners for connection security, missing API keys, and system resources- - Scheduler redesign with standalone modal, separate task list, detail and editor components, and project support- - Smooth response rendering and scroll stabilization across chat, terminals, and image viewer- - Chat width setting and reworked preferences panel- - Image viewer improvements with scroll support and expanded viewer- - Redesigned sidebar with reusable dropdown component and streamlined buttons- - Inline button confirmations for critical actions- - Improved login design and new logout button- - File browser enhanced with rename and file actions dropdown-- Git projects- - Git-based projects with clone authentication for public and private repositories-- Four new LLM providers: CometAPI, Z.AI, Moonshot AI, and AWS Bedrock-- Microsoft Dev Tunnels integration for secure remote access-- User data migration to `/usr` directory for cleaner separation of user and system files-- Subagents system with configurable agent profiles for different roles-- Memory operations offloaded to deferred tasks for better performance-- Environment variables can now configure settings via `A0_SET_*` prefix in `.env`-- Automatic migration with overwrite support for `.env`, scheduler, knowledge, and legacy directories-- Projects support extended to MCP, A2A, and external API-- Workdir outside project support for more flexible file organization-- Agent number tracking in backend and responses for multi-agent identification-- Many bug fixes and stability improvements across the UI, MCP tools, scheduler, uploads, and WebSocket handling---### v0.9.7 - Projects-[Release video](https://youtu.be/RrTDp_v9V1c)-- Projects management- - Support for custom instructions- - Integration with memory, knowledge, files- - Project specific secrets-- New Welcome screen/Dashboard-- New Wait tool-- Subordinate agent configuration override support-- Support for multiple documents at once in document_query_tool-- Improved context on interventions-- Openrouter embedding support-- Frontend components refactor and polishing-- SSH metadata output fix-- Support for windows powershell in local TTY utility-- More efficient selective streaming for LLMs-- UI output length limit improvements--### v0.9.6 - Memory Dashboard-[Release video](https://youtu.be/sizjAq2-d9s)-- Memory Management Dashboard-- Kali update-- Python update + dual installation-- Browser Use update-- New login screen-- LiteLLM retry on temporary errors-- Github Copilot provider support--### v0.9.5 - Secrets-[Release video](https://www.youtube.com/watch?v=VqxUdt7pjd8)-- Secrets management - agent can use credentials without seeing them-- Agent can copy paste messages and files without rewriting them-- LiteLLM global configuration field-- Browser agent configuration improvements-- Progressive web app support-- Extra model params support for JSON-- Short IDs for files and memories to prevent LLM errors-- Tunnel component frontend rework-- Fix for timezone change bug-- Notifications z-index fix--### v0.9.4 - Connectivity, UI-[Release video](https://www.youtube.com/watch?v=C2BAdDOduIc)-- External API endpoints-- Streamable HTTP MCP A0 server-- A2A (Agent to Agent) protocol - server+client-- New notifications system-- New local terminal interface for stability-- Rate limiter integration to models-- Delayed memory recall-- Smarter autoscrolling in UI-- Action buttons in messages-- Multiple API keys support-- Download streaming-- Tunnel URL QR code-- Internal fixes and optimizations--### v0.9.3 - Subordinates, memory, providers Latest-[Release video](https://www.youtube.com/watch?v=-LfejFWL34k)-- Faster startup/restart-- Subordinate agents can have dedicated prompts, tools and system extensions-- Streamable HTTP MCP server support-- Memory loading enhanced by AI filter-- Memory AI consolidation when saving memories-- Auto memory system configuration in settings-- LLM providers available are set by providers.yaml configuration file-- Venice.ai LLM provider supported-- Initial agent message for user + as example for LLM-- Docker build support for local images-- File browser fix--### v0.9.2 - Kokoro TTS, Attachments-[Release video](https://www.youtube.com/watch?v=sPot_CAX62I)--- Kokoro text-to-speech integration-- New message attachments system-- Minor updates: log truncation, hyperlink targets, component examples, api cleanup--### v0.9.1 - LiteLLM, UI improvements-[Release video](https://youtu.be/crwr0M4Spcg)-- Langchain replaced with LiteLLM- - Support for reasoning models streaming- - Support for more providers- - Openrouter set as default instead of OpenAI-- UI improvements- - New message grouping system- - Communication smoother and more efficient- - Collapsible messages by type- - Code execution tool output improved- - Tables and code blocks scrollable- - More space efficient on mobile-- Streamable HTTP MCP servers support-- LLM API URL added to models config for Azure, local and custom providers--### v0.9.0 - Agent roles, backup/restore-[Release video](https://www.youtube.com/watch?v=rMIe-TC6H-k)-- subordinate agents can use prompt profiles for different roles-- backup/restore functionality for easier upgrades-- security and bug fixes--### v0.8.7 - Formatting, Document RAG Latest-[Release video](https://youtu.be/OQJkfofYbus)-- markdown rendering in responses-- live response rendering-- document Q&A tool--### v0.8.6 - Merge and update-[Release video](https://youtu.be/l0qpK3Wt65A)-- Merge with Hacking Edition-- browser-use upgrade and integration re-work-- tunnel provider switch--### v0.8.5 - **MCP Server + Client**-[Release video](https://youtu.be/pM5f4Vz3_IQ)--- Agent Zero can now act as MCP Server-- Agent Zero can use external MCP servers as tools--### v0.8.4.1 - 2-Default models set to gpt-4.1-- Code execution tool improvements-- Browser agent improvements-- Memory improvements-- Various bugfixes related to context management-- Message formatting improvements-- Scheduler improvements-- New model provider-- Input tool fix-- Compatibility and stability improvements--### v0.8.4-[Release video](https://youtu.be/QBh_h_D_E24)--- **Remote access (mobile)**--### v0.8.3.1-[Release video](https://youtu.be/AGNpQ3_GxFQ)--- **Automatic embedding**--### v0.8.3-[Release video](https://youtu.be/bPIZo0poalY)--- ***Planning and scheduling***--### v0.8.2-[Release video](https://youtu.be/xMUNynQ9x6Y)--- **Multitasking in terminal**-- **Chat names**--### v0.8.1-[Release video](https://youtu.be/quv145buW74)--- **Browser Agent**-- **UX Improvements**--### v0.8-[Release video](https://youtu.be/cHDCCSr1YRI)--- **Docker Runtime**-- **New Messages History and Summarization System**-- **Agent Behavior Change and Management**-- **Text-to-Speech (TTS) and Speech-to-Text (STT)**-- **Settings Page in Web UI**-- **SearXNG Integration Replacing Perplexity + DuckDuckGo**-- **File Browser Functionality**-- **KaTeX Math Visualization Support**-- **In-chat File Attachments**--### v0.7-[Release video](https://youtu.be/U_Gl0NPalKA)--- **Automatic Memory**-- **UI Improvements**-- **Instruments**-- **Extensions Framework**-- **Reflection Prompts**-- **Bug Fixes**-## 🤝 Community and Support- [Join our Discord](https://discord.gg/B8KZKNsPpj) for live discussions or [visit our Skool Community](https://www.skool.com/agent-zero).diff --git a/docs/setup/installation.md b/docs/setup/installation.mdindex 353f7333a..024359a3a 100644--- a/docs/setup/installation.md+++ b/docs/setup/installation.md@@ -1,13 +1,37 @@# Installation Guide-Click to open a video to learn how to install Agent Zero:+## **Goal:** Go from zero to a first working chat with minimal setup.++----[](https://www.youtube.com/watch?v=2-qFNUvqrXA)+## Quick Start (Recommended)-## **Goal:** Go from zero to a first working chat with minimal setup.+The install script is the fastest way to get Agent Zero running. It handles Docker, image pulling, and container setup automatically.++**macOS / Linux:**+```bash+curl -fsSL https://bash.agent-zero.ai | bash+```++**Windows (PowerShell):**+```powershell+irm https://ps.agent-zero.ai | iex+```++**Docker (run directly):**+```bash+docker run -p 80:80 agent0ai/agent-zero+```++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).++---++## Manual Docker Setup+If you prefer to set things up manually, follow the steps below.-## Step 1: Install Docker Desktop+### Step 1: Install Docker DesktopDocker 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.@@ -39,7 +63,7 @@ Docker Desktop provides the runtime environment for Agent Zero, ensuring consist---<a name="windows-installation"></a>-## <img src="../res/setup/oses/windows.png" width="30" alt="Windows"/> Windows Installation+#### <img src="../res/setup/oses/windows.png" width="30" alt="Windows"/> Windows Installation**1.1. Download Docker Desktop**@@ -64,12 +88,12 @@ Once installed, launch Docker Desktop from your Start menu or desktop shortcut.✅ **Docker is now installed!**-### Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)+Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)---<a name="macos-installation"></a>-## <img src="../res/setup/oses/apple.png" width="30" alt="macOS"/> macOS Installation+#### <img src="../res/setup/oses/apple.png" width="30" alt="macOS"/> macOS Installation**1.1. Download Docker Desktop**@@ -101,12 +125,12 @@ Open Docker Desktop from your Applications folder.✅ **Docker is now installed!**-### Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)+Continue to [Step 2: Run Agent Zero](#step-2-run-agent-zero)---<a name="linux-installation"></a>-## <img src="../res/setup/oses/linux.png" width="30" alt="Linux"/> Linux Installation+#### <img src="../res/setup/oses/linux.png" width="30" alt="Linux"/> Linux Installation**1.1. Choose Installation Method**@@ -145,9 +169,9 @@ If you installed Docker Desktop, launch it from your applications menu.----## Step 2: Run Agent Zero+### Step 2: Run Agent Zero-### 2.1. Pull the Agent Zero Docker Image+#### 2.1. Pull the Agent Zero Docker Image**Using Docker Desktop GUI:**@@ -163,11 +187,11 @@ If you installed Docker Desktop, launch it from your applications menu.docker pull agent0ai/agent-zero```-### 2.2. (Optional) Map Folders for Persistence+#### 2.2. (Optional) Map Folders for PersistenceChoose or create a folder on your computer where Agent Zero will save its data.-### Setting up persistence is needed only if you want your data and files to remain available even after you delete the container.+Setting up persistence is needed only if you want your data and files to remain available even after you delete the container.You can pick any location you find convenient:@@ -182,7 +206,7 @@ You can map just the `/a0/usr` directory (recommended) or individual subfolders> [!TIP]> Choose a location that's easy to access and backup. All your Agent Zero data will be directly accessible in this directory.-### 2.3. Run the Container+#### 2.3. Run the Container**Using Docker Desktop GUI:**@@ -199,7 +223,7 @@ The container will start and show in the "Containers" tab:-### 2.4. Access the Web UI+#### 2.4. Access the Web UIThe 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: