vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/docs/guides/onboarding.md
Alessandro 50f80d57dc Refresh onboarding screenshots in docs 
Update first-run onboarding docs for the welcome screen, in-chat model gate, Cloud/AI account/Local provider paths, and explicit main and utility model choices.

Replace stale onboarding screenshots with optimized current assets and add gate, account, and local-provider captures.
2026-07-02 17:29:40 +02:00

3 KiB
Raw Blame History

First-Run Onboarding

Use onboarding the first time you open Agent Zero, or any time the Web UI says your models still need setup. The wizard helps you pick Cloud, AI account, or Local access, configure a main model, choose a utility model, and start chatting.

This example uses OpenRouter with a masked demo key. Replace the demo key with your own key.

Open Onboarding

Open the Web UI. The welcome screen can show account shortcuts, and the message composer is ready immediately.

Welcome screen with account and channel setup cards

If you send a message before models are configured, Agent Zero creates the chat, holds the message, and shows the model gate inside the conversation. Choose Cloud provider, AI account, or Local model to open onboarding.

Chat model gate with Cloud provider, AI account, and Local model choices

Choose A Provider Path

Choose Cloud when you want to paste an API key for OpenRouter, OpenAI, Anthropic, Google, Venice, or another hosted provider.

Cloud provider picker with hosted providers

Choose Account when you want to sign in with Codex/ChatGPT, GitHub Copilot, Google Cloud Gemini, or xAI Grok instead of pasting a provider key.

AI account picker with Codex, Copilot, Google Cloud Gemini, and Grok

Choose Local when you want to connect to Ollama, LM Studio, oMLX, llama.cpp, vLLM, or another model server running on your machine.

Local model provider picker with Ollama, LM Studio, oMLX, llama.cpp, and vLLM

Configure The Main Model

For API-key providers, choose the main model and paste the provider key. The screenshot uses a masked demo key.

OpenRouter setup with main model and masked API key

After the main model is selected, click Choose utility model.

Choose The Utility Model

The utility model handles quick internal tasks such as summaries, naming, and memory. A small, fast, cheap model usually works best here. The wizard may prefill a utility provider and model, but it remains an explicit choice.

Utility model step with OpenRouter and a fast Gemini model

Click Finish setup when the utility model looks right.

Start Chatting

The ready screen confirms that model setup is done. Optional setup cards may appear for integrations such as Telegram, Email, WhatsApp, or plugins.

Onboarding ready screen after setup

Click Start Chatting to create a chat and begin using Agent Zero.

Important

Do not reuse the fake key shown in this guide. Paste your own provider key, and do not share screenshots that reveal real keys or private account details.