mirror of
https://github.com/agent0ai/agent-zero.git
synced 2026-05-18 14:53:36 +00:00
954eca3563
Add a builtin `a0-setup-cli` skill for guiding host-side A0 connector setup, and restore the lightweight trigger-word based skill matching flow, which many users asked for. - add builtin `skills/a0-setup-cli/` with installer-first host setup guidance, container guardrails, fallback install paths, and example responses - fix `helpers.skills_cli` so builtin skills under `/skills` are discoverable, searchable, and validatable - restore trigger-pattern scoring in runtime `search_skills()` - re-enable `skills_tool:search` in the current tool flow - add lightweight lexical relevant-skill recall for the current user message without reintroducing memory/vector-db skill recall - update skill prompts to steer the agent toward search/load when requests match skill trigger phrases
118 lines
4.5 KiB
Markdown
118 lines
4.5 KiB
Markdown
# Quick Start
|
|
This guide provides a quick introduction to using Agent Zero. We'll cover the recommended install path and running your first Skill.
|
|
|
|
## Installation (recommended)
|
|
|
|
Run one command; the script handles Docker, image pull, and container setup.
|
|
|
|
**macOS / Linux:**
|
|
```bash
|
|
curl -fsSL https://bash.agent-zero.ai | bash
|
|
```
|
|
|
|
**Windows (PowerShell):**
|
|
```powershell
|
|
irm https://ps.agent-zero.ai | iex
|
|
```
|
|
|
|
Follow the CLI prompts for port and authentication, complete onboarding, then open the Web UI URL from the terminal.
|
|
|
|
> [!TIP]
|
|
> 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.
|
|
|
|
> [!NOTE]
|
|
> For manual Docker Desktop setup, volume mapping, and platform-specific detail, see the [Installation Guide](setup/installation.md#manual-installation-advanced).
|
|
|
|
## Use Agent Zero on your real local files
|
|
|
|
If you want Agent Zero to work on the actual files on your computer, this is the important part.
|
|
|
|
Agent Zero stays in Docker for safety. The A0 CLI installs and runs on your host machine. That host-side CLI is what lets Agent Zero work on the real files on your real computer.
|
|
|
|
**macOS / Linux:**
|
|
```bash
|
|
curl -LsSf https://raw.githubusercontent.com/agent0ai/a0-connector/main/install.sh | sh
|
|
```
|
|
|
|
**Windows (PowerShell):**
|
|
```powershell
|
|
irm https://raw.githubusercontent.com/agent0ai/a0-connector/main/install.ps1 | iex
|
|
```
|
|
|
|
Run those on the host machine, not inside the Agent Zero container.
|
|
|
|
Then launch:
|
|
|
|
```bash
|
|
a0
|
|
```
|
|
|
|
Once `a0` connects, open or create a chat there. That is the path that lets Agent Zero stay in Docker while still working on real local files on your machine.
|
|
|
|
For the full setup flow, 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).
|
|
|
|
### Open the Web UI and configure your API key
|
|
|
|
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.
|
|
|
|
|
|
|
|
Click **Add your API key** to open Settings and configure:
|
|
|
|
- **Default Provider:** OpenRouter (supports most models with a single API key)
|
|
- **Alternative Providers:** Anthropic, OpenAI, Ollama/LM Studio (local models), and many others
|
|
- **Model Selection:** Choose your chat model (e.g., `anthropic/claude-sonnet-4-6` for OpenRouter)
|
|
|
|
> [!NOTE]
|
|
> 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).
|
|
|
|
### Start your first chat
|
|
|
|
Once configured, you'll see the Agent Zero dashboard with access to:
|
|
|
|
- **Projects** - organize your work into projects
|
|
- **Memory** - open the memory dashboard
|
|
- **Scheduler** - create and manage planned tasks
|
|
- **Files** - open the File Browser
|
|
- **Settings** - configure models and preferences
|
|
- **System Stats** - monitor resource usage
|
|
|
|
Click **New Chat** to start creating with Agent Zero!
|
|
|
|
|
|
|
|
> [!TIP]
|
|
> 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.
|
|
>
|
|
> 
|
|
|
|
---
|
|
|
|
## Example Interaction
|
|
Let's ask Agent Zero to use one of the built-in skills. Here's how:
|
|
|
|
1. Type "Activate your brainstorming skill" in the chat input field and press Enter or click the send button.
|
|
2. Agent Zero will process your request. You'll see its thoughts and tool calls in the UI.
|
|
3. The agent will acknowledge the skill activation and ask you for a follow-up on the brainstorming request.
|
|
|
|
Here's an example of what you might see in the Web UI at step 3:
|
|
|
|
|
|
|
|
## Next Steps
|
|
Now that you've run a simple task, you can experiment with more complex requests. Try asking Agent Zero to:
|
|
|
|
* Connect to your email
|
|
* Execute shell commands
|
|
* Develop skills
|
|
* Explore web development tasks
|
|
* Develop A0 itself
|
|
|
|
### [Open A0 Usage Guide](guides/usage.md)
|
|
|
|
Provides more in-depth information on tools, projects, tasks, and backup/restore.
|
|
|
|
## 🎓 Video Tutorials
|
|
- [MCP Server Setup](https://youtu.be/pM5f4Vz3_IQ)
|
|
- [Projects & Workspaces](https://youtu.be/RrTDp_v9V1c)
|
|
- [Memory Management](https://youtu.be/sizjAq2-d9s)
|