diff --git a/README.md b/README.md index d3d5ebfc8..45efd23d1 100644 --- a/README.md +++ b/README.md @@ -3,49 +3,48 @@ Agent Zero Banner # Agent Zero -### A full Linux system for your AI agent. +### Give your agent a full Linux computer. -Agent Zero is an open, dynamic, organic agentic framework. One Docker container ships a full Linux system with a desktop and a plugin hub that the agent can extend using Skills. +Agent Zero is an open agent framework for work that needs more than chat: a Dockerized Linux desktop, a browser with DOM annotation, live document cowork, projects, skills, plugins, and a bridge back to your host machine. [![Website](https://img.shields.io/badge/Website-agent--zero.ai-0A192F?style=for-the-badge&logo=vercel&logoColor=white)](https://agent-zero.ai) [![Docs](https://img.shields.io/badge/Docs-Read%20the%20guides-1F6FEB?style=for-the-badge&logo=readthedocs&logoColor=white)](./docs/) [![Discord](https://img.shields.io/badge/Discord-Join%20us-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/B8KZKNsPpj) [![GitHub Sponsors](https://img.shields.io/badge/Sponsors-Thank%20you-FF69B4?style=for-the-badge&logo=githubsponsors&logoColor=white)](https://github.com/sponsors/agent0ai) - -[Install](#how-to-install) | -[Launcher](#a0-launcher) | -[What's Different](#what-makes-agent-zero-different) | -[A0 CLI](#a0-cli-connector-extend-onto-your-host-machine) | -[Docs](#documentation) - [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/agent0ai/agent-zero) -[Ask ChatGPT](https://chatgpt.com/?q=Analyze%20this%3A%20https%3A%2F%2Fgithub.com%2Fagent0ai%2Fagent-zero) | -[Ask Claude](https://claude.ai/new?q=Analyze%20this%3A%20https%3A%2F%2Fgithub.com%2Fagent0ai%2Fagent-zero) +[Quick Start](#quick-start) | +[Why Agent Zero](#why-agent-zero) | +[Try These First](#try-these-first) | +[Deep Dives](#deep-dives) | +[Docs](#documentation)
- -Agent Zero Installation Guide - +Agent Zero driving Blender in its built-in XFCE desktop
-# How To Install +# Why Agent Zero -Choose the install path that matches your machine. +| Feature | Why it matters | +| --- | --- | +| **Full Linux desktop** | The agent can use real GUI software, terminals, files, and desktop apps inside the Canvas. | +| **Browser DOM annotation** | Click page elements and turn them into inspect, change, lift, or review instructions. | +| **Live document cowork** | Edit Markdown, Writer, Spreadsheet, and Presentation files together instead of losing work in chat. | +| **Plugin Hub** | Install 100+ community plugins or publish your own extension points. | +| **Projects and memory** | Keep files, instructions, secrets, memories, repositories, and model presets isolated per project. | +| **Host-machine bridge** | Connect with the A0 CLI so the same agent can work in your real local repositories. | +| **Multi-agent cooperation** | Let agents delegate research, coding, analysis, or review tasks to focused subagents. | +| **Transparent internals** | Prompts, tools, plugins, skills, and settings are inspectable and editable. | -| Path | Best for | What it does | -| --- | --- | --- | -| **A0 Launcher** | Desktop users who want the guided path | Downloads Agent Zero, creates and manages local Instances, and helps set up the container runtime when needed. | -| **A0 Install** | Terminals, SSH sessions, servers, and scripted setup | Installs Agent Zero from the command line, reuses an existing Docker-compatible runtime first, and can run headlessly. | -| **Docker** | Machines that already have Docker ready | Runs the Agent Zero container directly. | +# Quick Start -## A0 Launcher +## Recommended: A0 Launcher -The desktop **A0 Launcher** is the recommended way to install Agent Zero on a personal machine. Download the Launcher, open it, and let it check your local runtime. If Docker is missing or stopped, the Launcher offers a setup path before it downloads Agent Zero. If you already host Agent Zero elsewhere, add it as a remote Instance and use the Launcher without local Docker setup. +The desktop **A0 Launcher** is the fastest guided path on a personal machine. Download it, open it, and let it check Docker, create Instances, manage ports, and connect to local or remote Agent Zero installs. -### Downloads +Agent Zero runs wherever Docker runs, from a $6 VPS or Raspberry Pi to a local workstation or GPU server. | Architecture | macOS | Linux | Windows | | --- | --- | --- | --- | @@ -54,6 +53,9 @@ The desktop **A0 Launcher** is the recommended way to install Agent Zero on a pe See the [A0 Launcher v1.2 release](https://github.com/agent0ai/a0-launcher/releases/tag/v1.2) for release notes and updater metadata. See the [Launcher guide](./docs/guides/launcher.md) for the first-run walkthrough. +
+Other install paths + ## A0 Install Use **A0 Install** when you want the terminal path: SSH sessions, servers, recovery shells, or a scriptable setup. It creates Dockerized Agent Zero instances, mounts each instance's data into `/a0/usr` inside the container, and uses a reuse-before-setup policy: it tries your current Docker CLI configuration, `DOCKER_HOST`, Docker contexts, and known local Docker-compatible endpoints before setting up a runtime. @@ -92,13 +94,28 @@ docker run -p 80:80 -v a0_usr:/a0/usr agent0ai/agent-zero Open the Web UI, configure your LLM provider, and start with a concrete task. For the full setup and onboarding experience, see the [Installation guide](./docs/setup/installation.md). -# What Makes Agent Zero Different +
+ +## Troubleshooting + +- **Docker is not running:** start Docker Desktop or your Docker service, then reopen the Launcher or rerun the install command. +- **Port 80 is already in use:** use the Launcher to pick another port, or run Docker directly with `-p 5080:80` and open `http://localhost:5080`. +- **Installing on a server:** use the A0 Install Quick Start command with `--quick-start --name agent-zero --port 5080`. +- **Still blocked:** see the [Troubleshooting guide](./docs/guides/troubleshooting.md). + +# Try These First + +- **Annotate a design you like:** "Open this template site in the Browser. I'll annotate the hero section - re-implement it in my project's React + Tailwind stack." +- **Cowork on a spreadsheet:** "Create an editable ODS budget model with assumptions and monthly projections." +- **Drive a desktop app:** "Use the Linux Desktop to open Blender and create a simple 3D logo for me." +- **Review a web UI:** "Open my local app in the Browser. I will annotate the page with comments; then implement the requested UI fixes." +- **Create a specialist:** "Create an Agent Profile for financial analysis with cautious reasoning, clear assumptions, and spreadsheet-first deliverables." +- **Recover a workspace:** "Show me recent Time Travel snapshots and explain what changed before I revert anything." + +# Deep Dives ## A Real Linux Desktop in the Canvas -Agent Zero driving Blender in its built-in XFCE desktop -
- Agent Zero opens its own Linux desktop inside the right-side Canvas. Not a remote VM, not a shared clipboard, but a real XFCE desktop session running in the container. That means the agent can drive *real desktop software*: open Blender to model a 3D object, jump into a terminal window, manage files visually, run a GUI tool that has no API. @@ -226,31 +243,9 @@ Almost nothing is hidden. Prompts live in `prompts/`, tools live in `tools/` or Agent Zero supports plugins, MCP, A2A, custom tools, custom prompts, project-scoped configuration, environment-based deployment settings, and a Web UI designed to keep the agent's work readable in real time. -## Try These First +## Time Travel -- **Annotate a design you like:** "Open this template site in the Browser. I'll annotate the hero section - re-implement it in my project's React + Tailwind stack." -- **Cowork on a spreadsheet:** "Create an editable ODS budget model with assumptions and monthly projections." -- **Drive a desktop app:** "Use the Linux Desktop to open Blender and create a simple 3D logo for me." -- **Review a web UI:** "Open my local app in the Browser. I will annotate the page with comments; then implement the requested UI fixes." -- **Create a specialist:** "Create an Agent Profile for financial analysis with cautious reasoning, clear assumptions, and spreadsheet-first deliverables." -- **Recover a workspace:** "Show me recent Time Travel snapshots and explain what changed before I revert anything." - -## Agent Zero and Space Agent - -Agent Zero is the open framework and Linux-powered agent workbench. - -[Space Agent](https://github.com/agent0ai/space-agent) is our newer product direction for the agent-shaped workspace: a Space the agent can reshape from inside your browser, with live demos, a desktop app, and a path to running a real server for yourself or your team. - -

- Watch Space Agent on YouTube -

- -If you want the raw power and deep customizability of an agent with a full Linux system, start here with Agent Zero. If you want the polished Space experience for easier personal, team, desktop, or self-hosted use, explore [Space Agent](https://github.com/agent0ai/space-agent). - - -## Time Travel (powered by Space Agent) - -Time Travel gives Agent Zero-owned `/a0/usr` workspaces snapshot history, diff inspection, travel, and revert. It is designed for recoverable agent work: see what changed, compare files, inspect a past state, and roll back when needed. Try it in Space Agent as well (link above). +Time Travel gives Agent Zero-owned `/a0/usr` workspaces snapshot history, diff inspection, travel, and revert. It is designed for recoverable agent work: see what changed, compare files, inspect a past state, and roll back when needed. Time Travel @@ -268,17 +263,6 @@ It is not a replacement for Git or backups. It is a practical safety layer for t - **Client/project isolation:** keep memory, secrets, instructions, files, and model choices separated by project. - **Scheduled operations:** run recurring checks and monitoring tasks with project-scoped context and credentials. -## Safety Model - -Agent Zero is powerful because it can use a real environment. - -- Keep it running inside Docker or another isolated environment. -- Do not mount your entire home directory unless you understand the risk. -- Grant A0 CLI Read+Write access and remote code execution only for machines and workspaces you trust. -- Store credentials in project secrets or settings, not in prompts or public files. -- Review actions that touch accounts, money, production systems, or private data. -- Keep backups for important workspaces. - ## Documentation | I want to... | Start here | @@ -314,3 +298,16 @@ You can help by improving docs, creating skills, publishing plugins, testing mod - [YouTube](https://www.youtube.com/@AgentZeroFW) for demos and tutorials. - [X](https://x.com/Agent0ai), [LinkedIn](https://www.linkedin.com/company/109758317), and [Warpcast](https://warpcast.com/agent-zero) for updates. - [GitHub Issues](https://github.com/agent0ai/agent-zero/issues) for bugs and feature requests. + +[Space Agent](https://github.com/agent0ai/space-agent) is the related, more polished product direction for the agent-shaped workspace. Agent Zero remains the open framework and Linux-powered workbench. + +## Safety Model + +Agent Zero is powerful because it can use a real environment. + +- Keep it running inside Docker or another isolated environment. +- Do not mount your entire home directory unless you understand the risk. +- Grant A0 CLI Read+Write access and remote code execution only for machines and workspaces you trust. +- Store credentials in project secrets or settings, not in prompts or public files. +- Review actions that touch accounts, money, production systems, or private data. +- Keep backups for important workspaces.