mirror of https://github.com/agent0ai/agent-zero.git synced 2026-05-17 04:01:13 +00:00

History

Alessandro d637f3c2b6 Some checks are pending Build And Publish Docker Images / plan (push) Waiting to run Details Build And Publish Docker Images / build (push) Blocked by required conditions Details Add refactor guardrails and runtime docs Cover the modal/surface boundary, Desktop ownership, Office document-only behavior, explicit Desktop opens, plugin-owned runtime paths, renamed skills, connector ownership rules, Browser context handoff, and Playwright cache stability. Update operator docs to match the retained Docker Playwright install path.		2026-05-07 00:15:50 +02:00
..
agents	Defer Office desktop startup	2026-05-03 03:26:04 +02:00
developer	docs: update documentation about agent profiles creation flow	2026-04-22 14:26:10 +02:00
guides	Add refactor guardrails and runtime docs	2026-05-07 00:15:50 +02:00
res	docs: update OAuth README screenshot	2026-05-02 21:07:22 +02:00
setup	Add refactor guardrails and runtime docs	2026-05-07 00:15:50 +02:00
quickstart.md	add a0-setup-cli Skill and restore lexical trigger matching	2026-04-11 18:03:05 +02:00
README.md	docs: update documentation about agent profiles creation flow	2026-04-22 14:26:10 +02:00

README.md

Agent Zero Documentation

Welcome to the Agent Zero documentation hub. Whether you're getting started or diving deep into the framework, you'll find comprehensive guides below.

Quick Start

Quickstart Guide: Get up and running in 5 minutes with Agent Zero.
Installation Guide: Install scripts, updates, and advanced Docker setup (includes How to Update).
A0 CLI Connector: Install the terminal-native connector, connect it to Agent Zero, and copy a setup brief for another agent.
Self Update: How the in-app updater works (technical reference).
VPS Deployment: Deploy Agent Zero on a remote server.
Development Setup: Set up a local development environment.

User Guides

Usage Guide: Comprehensive guide to Agent Zero's features and capabilities.
A0 CLI Connector: Terminal-first companion workflow for Agent Zero.
Agent Profiles: Create and select specialized profiles, prompt overrides, and profile-specific model config.
Projects Tutorial: Learn to create isolated workspaces with dedicated context and memory.
API Integration: Add external APIs without writing code.
MCP Setup: Configure Model Context Protocol servers.
A2A Setup: Enable agent-to-agent communication.
Troubleshooting: Solutions to common issues and FAQs.

Developer Documentation

Architecture Overview: Understand Agent Zero's internal structure and components.
Plugins: Build plugins with plugin.yaml, scoped settings, and activation toggles.
Extensions: Create custom extensions to extend functionality.
Connectivity: Connect to Agent Zero from external applications.
WebSockets: Real-time communication infrastructure.
MCP Configuration: Advanced MCP server configuration.
Notifications: Notification system architecture and setup.
Contributing Skills: Create and share agent skills.
Contributing Guide: Contribute to the Agent Zero project.

Community & Support

Join the Community: Connect with other users on Discord to discuss ideas, ask questions, and collaborate.
Share Your Work: Show off your Agent Zero creations and workflows in the Show and Tell area.
Report Issues: Use the GitHub issue tracker to report bugs or suggest features.
Follow Updates: Subscribe to the YouTube channel for tutorials and release videos.

Your journey with Agent Zero starts now!

Ready to dive in? Start with the Quickstart Guide for the fastest path to your first chat, or follow the Installation Guide for a detailed setup walkthrough.