|
1 | 1 | # Quick Start |
2 | | -This guide provides a quick introduction to using Agent Zero. We'll cover the essential installation steps and running your first Skill. |
| 2 | +This guide provides a quick introduction to using Agent Zero. We'll cover the recommended install path and running your first Skill. |
3 | 3 |
|
4 | | -## Installation Steps |
| 4 | +## Installation (recommended) |
5 | 5 |
|
6 | | -### Step 1: Install Docker Desktop |
7 | | - |
8 | | -Download and install Docker Desktop for your operating system: |
9 | | - |
10 | | -- **Windows:** Download from [Docker Desktop](https://www.docker.com/products/docker-desktop/) and run the installer with default settings |
11 | | -- **macOS:** Download for Apple Silicon or Intel, drag to Applications, and enable the Docker socket in Settings → Advanced |
12 | | -- **Linux:** Install Docker Desktop or docker-ce following the [official instructions](https://docs.docker.com/desktop/install/linux-install/) |
13 | | - |
14 | | -> [!TIP] |
15 | | -> For complete OS-specific installation instructions, see the [full Installation Guide](setup/installation.md#step-1-install-docker-desktop). |
16 | | -
|
17 | | -### Step 2: Pull the Agent Zero Image |
18 | | - |
19 | | -Using Docker Desktop GUI, search for `agent0ai/agent-zero` and click Pull, or use the terminal: |
| 6 | +Run one command; the script handles Docker, image pull, and container setup. |
20 | 7 |
|
| 8 | +**macOS / Linux:** |
21 | 9 | ```bash |
22 | | -docker pull agent0ai/agent-zero |
| 10 | +curl -fsSL https://bash.agent-zero.ai | bash |
23 | 11 | ``` |
24 | 12 |
|
25 | | -### Step 3: Run the Container |
26 | | - |
27 | | -**Using Docker Desktop:** Go to Images tab, click Run next to `agent0ai/agent-zero`, open Optional settings, map a host port to container port `80` (use `0` for automatic assignment), then click Run. |
| 13 | +**Windows (PowerShell):** |
| 14 | +```powershell |
| 15 | +irm https://ps.agent-zero.ai | iex |
| 16 | +``` |
28 | 17 |
|
29 | | -**Using Terminal:** |
| 18 | +Follow the CLI prompts for port and authentication, complete onboarding, then open the Web UI URL from the terminal. |
30 | 19 |
|
31 | | -```bash |
32 | | -docker run -p 0:80 agent0ai/agent-zero |
33 | | -``` |
| 20 | +> [!TIP] |
| 21 | +> To update later, use **Settings → Update → Self Update** (see [How to Update](setup/installation.md#how-to-update-agent-zero)). Always create a backup under **Settings → Backup & Restore** first. |
34 | 22 |
|
35 | | -The container will start in a few seconds. Find the mapped port in Docker Desktop (shown as `<PORT>:80`). |
| 23 | +> [!NOTE] |
| 24 | +> For manual Docker Desktop setup, volume mapping, and platform-specific detail, see the [Installation Guide](setup/installation.md#manual-installation-advanced). |
36 | 25 |
|
37 | | -### Step 4: Open the Web UI and Configure API Key |
| 26 | +### Open the Web UI and configure your API key |
38 | 27 |
|
39 | | -Open your browser and navigate to `http://localhost:<PORT>`. The Web UI will show a warning banner about missing API key. |
| 28 | +Open your browser and navigate to `http://localhost:<PORT>`. The Web UI will show the onboarding banner. Click Start Onboarding to set your AI models and API key. |
40 | 29 |
|
41 | 30 |  |
42 | 31 |
|
43 | 32 | Click **Add your API key** to open Settings and configure: |
44 | 33 |
|
45 | 34 | - **Default Provider:** OpenRouter (supports most models with a single API key) |
46 | 35 | - **Alternative Providers:** Anthropic, OpenAI, Ollama/LM Studio (local models), and many others |
47 | | -- **Model Selection:** Choose your chat model (e.g., `anthropic/claude-sonnet-4-5` for OpenRouter) |
| 36 | +- **Model Selection:** Choose your chat model (e.g., `anthropic/claude-sonnet-4-6` for OpenRouter) |
48 | 37 |
|
49 | 38 | > [!NOTE] |
50 | 39 | > Agent Zero supports any LLM provider, including local models via Ollama. For detailed provider configuration and local model setup, see the [Installation Guide](setup/installation.md#choosing-your-llms). |
51 | 40 |
|
52 | | -### Step 5: Start Your First Chat |
| 41 | +### Start your first chat |
53 | 42 |
|
54 | 43 | Once configured, you'll see the Agent Zero dashboard with access to: |
55 | 44 |
|
|
0 commit comments