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

History

Alessandro 6d29268cbd 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 refactor: align skills and tool guidance Rename high-impact skills to task-oriented names and move plugin-owned skills into their owning plugin folders.\n\nAlign renamed skill frontmatter with the official SKILL.md standard by keeping trigger language in name/description metadata, replacing the old create-skill wizard with build-skill, and updating browser, A0 connector, computer-use, CLI setup, and scheduler skill references.\n\nTighten the recurring cross-provider guidance gaps surfaced by the evidence sweeps: memory requests now avoid promptinclude-file routing, scheduler prompts distinguish cron schedules from planned ISO dates, document questions prefer document_query, skills_tool search/read_file usage is clearer, normal notifications set info/priority 10, and local/host text editors preserve patch intent.\n\nUpdate regression tests for the renamed skills, plugin ownership, prompt budget reality, and standard frontmatter shape.		2026-05-10 07:13:14 +02:00
..
agents	docs: add model efficiency scorecard	2026-05-10 07:12:53 +02:00
developer	docs: make Agent Zero guides more human	2026-05-09 00:02:11 +02:00
guides	refactor: align skills and tool guidance	2026-05-10 07:13:14 +02:00
res	Document first-run onboarding flow	2026-05-09 08:05:09 +02:00
setup	Document first-run onboarding flow	2026-05-09 08:05:09 +02:00
quickstart.md	Document first-run onboarding flow	2026-05-09 08:05:09 +02:00
README.md	Document first-run onboarding flow	2026-05-09 08:05:09 +02:00

README.md

Agent Zero Documentation

Welcome to the Agent Zero documentation hub. Start with the practical guides below: install it, open the Web UI, connect your host machine when needed, and learn the main workflows by sight.

For architecture and source-linked internals, use DeepWiki for Agent Zero. The local docs focus on practical setup, screenshots, and user workflows.

Quick Start

Quickstart Guide: Get up and running in 5 minutes with Agent Zero.
First-Run Onboarding: Choose Cloud or Local, add a provider key, and select main and utility models.
Installation Guide: Install scripts, updates, and advanced Docker setup (includes How to Update).
A0 CLI Connector: Install the host connector for a running Agent Zero instance, use the command palette, and switch Browser modes.
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: Practical tour of Agent Zero's main workflows.
First-Run Onboarding: Set up OpenRouter, our proxy API or another provider with the guided wizard.
Browser Guide: Use the built-in Browser, live Canvas surface, annotations, screenshots, host browser mode, and extensions.
Desktop Guide: Use the built-in Linux desktop, GUI apps, and LibreOffice Writer/Calc/Impress Cowork.
A0 CLI Connector: Terminal-first host connector for Agent Zero, with screenshots of the host picker, connected shell, command palette, and Browser modes.
Create a Small Plugin: Build and review a tiny Web UI plugin that adds an unread dot to the chat list.
Skills Guide: Open the Skills selector, add active skills, and remove prompt extras you no longer need.
Agent Profiles: Switch the current chat profile or create a new guided profile from the chat input.
Model Presets: Create simple named shortcuts for model setups.
Memory Guide: Search, edit, delete, and curate memories so useful context does not become stale noise.
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.

Technical Reference

DeepWiki for Agent Zero: Architecture, Web UI internals, plugin lifecycle, backend APIs, deployment details, and source-linked explanations.
Architecture: Short local handoff to DeepWiki plus practical starting points.
Plugins: Compact plugin starting points and sharing checklist.
Extensions: Short guide for when an extension is the right tool.
Connectivity: Choose between A0 CLI, MCP, A2A, and external APIs.
WebSockets: Short local handoff to DeepWiki and source files.
MCP Configuration: Compact reference for MCP JSON.
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.

Documentation Ownership

Content type	Home
Setup, screenshots, and everyday workflows	These docs
Architecture and source-linked internals	DeepWiki
Exact behavior	The current source code
Community help and examples	Discord, Skool, GitHub discussions

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.