main
md 159 lines 10.1 KB
Rendered Raw
1 ![Agent Zero Logo](res/header.png)
2 # Agent Zero Documentation
3
4 Welcome to the Agent Zero documentation hub. Start with the practical guides
5 below: install it, open the Web UI, connect your host machine when needed, and
6 learn the main workflows by sight.
7
8 For architecture and source-linked internals, use
9 [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero). The local
10 docs focus on practical setup, screenshots, and user workflows.
11
12 ## Quick Start
13
14 - **[Quickstart Guide](quickstart.md):** Get up and running in 5 minutes with Agent Zero.
15 - **[Agent Zero Launcher](guides/launcher.md):** Use the desktop app to set up Docker, install Agent Zero, open Instances, or connect a remote Instance.
16 - **[First-Run Onboarding](guides/onboarding.md):** Choose Cloud, AI account, or Local access, then select main and utility models.
17 - **[Installation Guide](setup/installation.md):** A0 Launcher downloads, A0 Install, direct Docker, updates, and advanced Docker setup (includes [How to Update](setup/installation.md#how-to-update-agent-zero)).
18 - **[A0 CLI Connector](guides/a0-cli-connector.md):** Install the host connector for a running Agent Zero instance, use the command palette, and switch Browser modes.
19 - **[Self Update](guides/self-update.md):** How the in-app updater works (technical reference).
20 - **[VPS Deployment](setup/vps-deployment.md):** Deploy Agent Zero on a remote server.
21 - **[Development Setup](setup/dev-setup.md):** Set up a local development environment.
22
23 ## User Guides
24
25 - **[Usage Guide](guides/usage.md):** Practical tour of Agent Zero's main workflows.
26 - **[Agent Zero Launcher](guides/launcher.md):** Fresh-machine Launcher walkthrough, Docker setup gate, Installs, Instances, and docs screenshot capture with Playwright/Electron.
27 - **[First-Run Onboarding](guides/onboarding.md):** Set up OpenRouter, our proxy API or another provider with the guided wizard.
28 - **[Browser Guide](guides/browser.md):** Use the built-in Browser, live Canvas surface, annotations, screenshots, host browser mode, and extensions.
29 - **[Desktop Guide](guides/desktop.md):** Use the built-in Linux desktop, GUI apps, and LibreOffice Writer/Calc/Impress Cowork.
30 - **[A0 CLI Connector](guides/a0-cli-connector.md):** Terminal-first host connector for Agent Zero, with screenshots of the host picker, connected shell, command palette, and Browser modes.
31 - **[Create a Small Plugin](guides/create-plugin.md):** Build and review a tiny Web UI plugin that adds an unread dot to the chat list.
32 - **[Skills Guide](guides/skills.md):** Open the Skills selector, add active skills, and remove prompt protocol entries you no longer need.
33 - **[Agent Profiles](guides/agent-profiles.md):** Create and manage profiles in Easy or Advanced mode, set project availability, and control Tool, MCP, and Skill access.
34 - **[Model Presets](guides/model-presets.md):** Create simple named shortcuts for model setups.
35 - **[Memory Guide](guides/memory.md):** Search, edit, delete, and curate memories so useful context does not become stale noise.
36 - **[Projects Tutorial](guides/projects.md):** Learn to create isolated workspaces with dedicated context and memory.
37 - **[API Integration](guides/api-integration.md):** Add external APIs without writing code.
38 - **[MCP Setup](guides/mcp-setup.md):** Configure Model Context Protocol servers.
39 - **[A2A Setup](guides/a2a-setup.md):** Enable agent-to-agent communication.
40 - **[Troubleshooting](guides/troubleshooting.md):** Solutions to common issues and FAQs.
41
42 ## Technical Reference
43
44 - **[DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero):** Architecture, Web UI internals, plugin lifecycle, backend APIs, deployment details, and source-linked explanations.
45 - **[Architecture](developer/architecture.md):** Short local handoff to DeepWiki plus practical starting points.
46 - **[Plugins](developer/plugins.md):** Compact plugin starting points and sharing checklist.
47 - **[Extensions](developer/extensions.md):** Short guide for when an extension is the right tool.
48 - **[Connectivity](developer/connectivity.md):** Choose between A0 CLI, MCP, A2A, and external APIs.
49 - **[WebSockets](developer/websockets.md):** Short local handoff to DeepWiki and source files.
50 - **[MCP Configuration](developer/mcp-configuration.md):** Compact reference for MCP JSON.
51 - **[Notifications](developer/notifications.md):** Notification system architecture and setup.
52 - **[Contributing Skills](developer/contributing-skills.md):** Create and share agent skills.
53 - **[Contributing Guide](guides/contribution.md):** Contribute to the Agent Zero project.
54
55 ## Community & Support
56
57 - **Join the Community:** Connect with other users on [Discord](https://discord.gg/B8KZKNsPpj) to discuss ideas, ask questions, and collaborate.
58 - **Share Your Work:** Show off your Agent Zero creations and workflows in the [Show and Tell](https://github.com/agent0ai/agent-zero/discussions/categories/show-and-tell) area.
59 - **Report Issues:** Use the [GitHub issue tracker](https://github.com/agent0ai/agent-zero/issues) to report bugs or suggest features.
60 - **Follow Updates:** Subscribe to the [YouTube channel](https://www.youtube.com/@AgentZeroFW) for tutorials and release videos.
61
62 ---
63
64 ## Table of Contents
65
66 - [Quick Start](#quick-start)
67 - [Quickstart Guide](quickstart.md)
68 - [Agent Zero Launcher](guides/launcher.md)
69 - [First-Run Onboarding](guides/onboarding.md)
70 - [Installation Guide](setup/installation.md)
71 - [How to Update Agent Zero](setup/installation.md#how-to-update-agent-zero)
72 - [Manual Installation (Advanced)](setup/installation.md#manual-installation-advanced)
73 - [Step 1: Install Docker Desktop](setup/installation.md#step-1-install-docker-desktop)
74 - [Windows Installation](setup/installation.md#windows-installation)
75 - [macOS Installation](setup/installation.md#macos-installation)
76 - [Linux Installation](setup/installation.md#linux-installation)
77 - [Step 2: Run Agent Zero](setup/installation.md#step-2-run-agent-zero)
78 - [Pull Docker Image](setup/installation.md#21-pull-the-agent-zero-docker-image)
79 - [Map Folders for Persistence](setup/installation.md#22-optional-map-folders-for-persistence)
80 - [Run the Container](setup/installation.md#23-run-the-container)
81 - [Access the Web UI](setup/installation.md#24-access-the-web-ui)
82 - [Step 3: Configure Agent Zero](setup/installation.md#step-3-configure-agent-zero)
83 - [Settings Configuration](setup/installation.md#settings-configuration)
84 - [Agent Configuration](setup/installation.md#agent-configuration)
85 - [Chat Model Settings](setup/installation.md#chat-model-settings)
86 - [API Keys](setup/installation.md#api-keys)
87 - [Authentication](setup/installation.md#authentication)
88 - [Choosing Your LLMs](setup/installation.md#choosing-your-llms)
89 - [Installing Ollama (Local Models)](setup/installation.md#installing-and-using-ollama-local-models)
90 - [Using on Mobile Devices](setup/installation.md#using-agent-zero-on-your-mobile-device)
91 - [Self Update (technical)](guides/self-update.md)
92 - [VPS Deployment](setup/vps-deployment.md)
93 - [Development Setup](setup/dev-setup.md)
94 - [A0 CLI Connector](guides/a0-cli-connector.md)
95
96 - [User Guides](#user-guides)
97 - [Usage Guide](guides/usage.md)
98 - [Basic Operations](guides/usage.md#basic-operations)
99 - [Plugins And Plugin Hub](guides/usage.md#plugins-and-plugin-hub)
100 - [Skills, Agent Profiles, And Model Presets](guides/usage.md#skills-agent-profiles-and-model-presets)
101 - [Skills](guides/usage.md#skills)
102 - [Agent Profiles](guides/usage.md#agent-profiles)
103 - [Model Presets](guides/usage.md#model-presets)
104 - [File Attachments](guides/usage.md#file-attachments)
105 - [Tool Usage](guides/usage.md#tool-usage)
106 - [Browser Tool And Surface](guides/usage.md#browser-tool-and-surface)
107 - [Desktop Surface](guides/usage.md#desktop-surface)
108 - [Agent-To-Agent Communication](guides/usage.md#agent-to-agent-communication)
109 - [Multi-Agent Cooperation](guides/usage.md#multi-agent-cooperation)
110 - [Projects](guides/usage.md#projects)
111 - [Tasks And Scheduling](guides/usage.md#tasks-and-scheduling)
112 - [Secrets And Variables](guides/usage.md#secrets-and-variables)
113 - [Remote Access Via Tunneling](guides/usage.md#remote-access-via-tunneling)
114 - [Voice Interface](guides/usage.md#voice-interface)
115 - [Mathematical Expressions](guides/usage.md#mathematical-expressions)
116 - [File Browser](guides/usage.md#file-browser)
117 - [Memory Management](guides/usage.md#memory-management)
118 - [Backup And Restore](guides/usage.md#backup-and-restore)
119 - [Agent Zero Launcher](guides/launcher.md)
120 - [Browser Guide](guides/browser.md)
121 - [Desktop Guide](guides/desktop.md)
122 - [A0 CLI Connector](guides/a0-cli-connector.md)
123 - [Create a Small Plugin](guides/create-plugin.md)
124 - [Skills Guide](guides/skills.md)
125 - [Agent Profiles](guides/agent-profiles.md)
126 - [Model Presets](guides/model-presets.md)
127 - [Memory Guide](guides/memory.md)
128 - [Projects Tutorial](guides/projects.md)
129 - [API Integration](guides/api-integration.md)
130 - [MCP Setup](guides/mcp-setup.md)
131 - [A2A Setup](guides/a2a-setup.md)
132 - [Troubleshooting](guides/troubleshooting.md)
133
134 - [Technical Reference](#technical-reference)
135 - [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero)
136 - [Architecture](developer/architecture.md)
137 - [Plugins](developer/plugins.md)
138 - [Extensions](developer/extensions.md)
139 - [Connectivity](developer/connectivity.md)
140 - [WebSockets](developer/websockets.md)
141 - [MCP Configuration](developer/mcp-configuration.md)
142 - [Notifications](developer/notifications.md)
143 - [Contributing Skills](developer/contributing-skills.md)
144 - [Contributing Guide](guides/contribution.md)
145
146 ---
147
148 ## Documentation Ownership
149
150 | Content type | Home |
151 | --- | --- |
152 | Setup, screenshots, and everyday workflows | These docs |
153 | Architecture and source-linked internals | [DeepWiki](https://deepwiki.com/agent0ai/agent-zero) |
154 | Exact behavior | The current source code |
155 | Community help and examples | Discord, Skool, GitHub discussions |
156
157 ### Your journey with Agent Zero starts now!
158
159 Ready to dive in? Start with the [Quickstart Guide](quickstart.md) for the fastest path to your first chat, or follow the [Installation Guide](setup/installation.md) for a detailed setup walkthrough.