main
md 169 lines 6.31 KB
Rendered Raw
1 # Quick Start
2
3 This guide gets you from install to a first useful chat. Keep it simple: start
4 Agent Zero, add a model or API key, open the Web UI, and give it a concrete job.
5
6 ## Installation (recommended)
7
8 Choose the path that matches your machine:
9
10 - Use [A0 Launcher](guides/launcher.md) if you want a desktop app on a fresh
11 machine. It can set up the local runtime, download Agent Zero, open
12 Instances, or save a remote Instance URL.
13 - Use A0 Install if you want the terminal path. The script handles Docker
14 detection, image pull, and container setup.
15
16 **macOS / Linux:**
17 ```bash
18 curl -fsSL https://bash.agent-zero.ai | bash
19 ```
20
21 **Windows (PowerShell):**
22 ```powershell
23 irm https://ps.agent-zero.ai | iex
24 ```
25
26 Follow the CLI prompts for port and authentication, complete onboarding, then open the Web UI URL from the terminal.
27
28 > [!TIP]
29 > To update later, open **Settings UI -> Update tab -> Open Self Update** (see [How to Update](setup/installation.md#how-to-update-agent-zero)). Backups are automatically managed internally.
30
31 > [!NOTE]
32 > For Launcher downloads, headless installer flags, direct Docker, manual Docker Desktop setup, volume mapping, and platform-specific detail, see the [Installation Guide](setup/installation.md).
33
34 ## Use Agent Zero on your real local files
35
36 If you want Agent Zero to work on the actual files on your computer, this is the important part.
37
38 Agent Zero stays in Docker for safety. The A0 CLI installs and runs on your host machine. It is not another CLI agent; it is the connector that lets your running Agent Zero instance work on the real files on your real computer.
39
40 **macOS / Linux:**
41 ```bash
42 curl -LsSf https://cli.agent-zero.ai/install.sh | sh
43 ```
44
45 **Windows (PowerShell):**
46 ```powershell
47 irm https://cli.agent-zero.ai/install.ps1 | iex
48 ```
49
50 Run those on the host machine, not inside the Agent Zero container.
51
52 Then launch:
53
54 ```bash
55 a0
56 ```
57
58 Once `a0` connects, open or create a chat there. The reasoning still belongs to Agent Zero; the CLI is the host bridge that lets it work on real local files on your machine.
59
60 For the full setup flow, host picker screenshots, command palette guidance, Browser mode commands, manual fallback install paths, remote-host tips, and a copy-ready brief for another agent, see the [A0 CLI Connector guide](guides/a0-cli-connector.md).
61
62 ### Open the Web UI and complete onboarding
63
64 Open your browser and navigate to `http://localhost:<PORT>`. The Web UI will
65 open on the welcome screen. If models still need setup, send a message or use
66 the setup shortcuts to choose Cloud, AI account, or Local access, then select
67 your main and utility models.
68
69 ![Agent Zero Web UI](res/setup/6-docker-a0-running-new.png)
70
71 For a screenshot walkthrough using OpenRouter, see the
72 [First-Run Onboarding guide](guides/onboarding.md).
73
74 > [!NOTE]
75 > Agent Zero supports hosted providers, account-backed providers, and local
76 > models. Choose a strong main model for chat and a fast utility model for
77 > internal tasks.
78
79 ### Start your first chat
80
81 Once configured, you will see the Agent Zero dashboard.
82
83 ![Agent Zero dashboard](res/usage/webui/dashboard.png)
84
85 Click **New Chat** and start with a specific request.
86
87 Good first prompts:
88
89 ```text
90 Create a short plan for organizing my project notes.
91 ```
92
93 ```text
94 Use the Browser to research three options for this tool and summarize the tradeoffs.
95 ```
96
97 ```text
98 Help me create a project for this repository and write good instructions for it.
99 ```
100
101 > [!TIP]
102 > The Web UI provides a comprehensive chat actions dropdown with options for managing conversations, including creating new chats, resetting, saving/loading, and many more advanced features. Chats are saved in JSON format in the `/usr/chats` directory.
103 >
104 > ![Chat Actions Dropdown](res/quickstart/ui_chat_management.png)
105
106 ---
107
108 ## Example Interaction
109
110 Try a small request first so you can see how Agent Zero thinks, uses tools, and
111 reports progress.
112
113 1. Type a concrete request in the chat input and press Enter.
114 2. Watch the streamed response and any tool calls.
115 3. Redirect the agent if it starts moving in the wrong direction.
116 4. Ask for the final result in the format you want.
117
118 Here's an example of what you might see in the Web UI at step 3:
119
120 ![1](res/quickstart/image-24.png)
121
122 ## Next Steps
123 Now that you've run a simple task, you can experiment with more complex requests. Try asking Agent Zero to:
124
125 - Create a project for a focused workspace.
126 - Use the built-in Browser to research, screenshot, or annotate a page.
127 - Open the Desktop when you want Linux GUI apps or LibreOffice Cowork.
128 - Review Memory when Agent Zero seems to keep the wrong assumption.
129 - Connect A0 CLI when Agent Zero should work on host-machine files.
130 - Use **+ -> Skills** when you want to pin or remove a skill in the current chat.
131 - Switch Agent Profiles from the menu near the chat input when you want a different working style.
132 - Use the first model dropdown when you want to choose or edit Model Presets.
133 - Attach files and ask for a summary, edit, or conversion.
134 - Create a scheduled task for recurring work.
135 - Explore plugins when you need installed integrations or custom UI features.
136
137 ### [Open A0 Browser Guide](guides/browser.md)
138
139 Explains the built-in Browser, live Browser Canvas, screenshots, annotations, host-browser mode through A0 CLI, and Chrome extensions.
140
141 ### [Open A0 Desktop Guide](guides/desktop.md)
142
143 Shows the right-side Canvas Linux desktop, the New menu for Markdown/Writer/Spreadsheet/Presentation files, and LibreOffice Cowork.
144
145 ### [Open A0 Memory Guide](guides/memory.md)
146
147 Explains how to search, edit, delete, export, and curate memories before stale context starts steering the agent.
148
149 ### [Open A0 Skills Guide](guides/skills.md)
150
151 Shows the chat input **+** menu, the Skills selector, and how active skills are added to prompt protocol.
152
153 ### [Open A0 Agent Profiles Guide](guides/agent-profiles.md)
154
155 Shows how to switch profiles, create one in Easy mode, edit prompts in Advanced
156 mode, and set Tool, MCP, Skill, and project-availability policies.
157
158 ### [Open A0 Model Presets Guide](guides/model-presets.md)
159
160 Explains presets as simple named shortcuts for model setups.
161
162 ### [Open A0 Usage Guide](guides/usage.md)
163
164 Provides more in-depth information on chat controls, tools, projects, tasks, and backup/restore.
165
166 ## Video Tutorials
167 - [MCP Server Setup](https://youtu.be/pM5f4Vz3_IQ)
168 - [Projects & Workspaces](https://youtu.be/RrTDp_v9V1c)
169 - [Memory Management](https://youtu.be/sizjAq2-d9s)