快速开始
Quickstart 是引导式安装流程,可一次性将你从全新安装带到可用的智能体。它运行于三种环境:CLI、zerocode 终端界面以及 web gateway。这三者驱动相同的底层流程,因此生成的配置完全一致。可根据你所处的环境选用任意一种。
安装
Unix 快速路径
curl -fsSL https://raw.githubusercontent.com/zeroclaw-labs/zeroclaw/master/install.sh | sh
此路由为非交互式,不会打开选择器。
它会优先使用匹配的预构建二进制文件,并在需要时回退到源代码构建。
预构建归档可能包含 zerocode;非交互式源代码回退会安装默认应用,而不打开选择器。
该命令使用固定的特征集。
如果需要从源代码构建,且系统中缺少 Rust,安装程序可以自动安装 Rust。
在 Unix 上,安装程序会在允许的情况下更新 shell 配置文件;在依赖新的 PATH 之前,请重新加载父 shell。
安装程序会跳过设置,并打印 zeroclaw quickstart 作为下一步。
Unix 指导路径
git clone https://github.com/zeroclaw-labs/zeroclaw.git
cd zeroclaw
./install.sh
此路由带有引导功能,可能会提供受支持的选项。
在受支持的目标平台上,它提供预构建安装或从源代码安装。
预构建归档可能包含 zerocode;源选择默认会选中它,并允许应用选择。
源路径还允许你选择可选的 Cargo 特性。
如果需要从源代码构建,且系统中缺少 Rust,安装程序可以自动安装 Rust。
在 Unix 上,安装程序会在允许的情况下更新 shell 配置文件;在依赖新的 PATH 之前,请重新加载父 shell。
对于未配置的安装,它提供 zeroclaw quickstart 或基于浏览器的快速入门。
Windows 预构建路径
使用 Windows 安装指南 中的 PowerShell 代码块。安装和 PATH 设置是幂等的;Quickstart 仍可运行。
此路由为非交互式,不会打开选择器。
此路由会安装预构建的发行版存档。
归档文件中也可能包含 zerocode;是否提供取决于发布资源。
该命令使用固定的特征集。
此预构建方案无需 Rust 工具链。
在 Windows 上,PowerShell 路径会更新当前进程和持久化的用户 PATH。
PowerShell 代码块最后会自动运行 zeroclaw quickstart。
高级源路径
Unix
./install.sh --source
此路由带有引导功能,可能会提供受支持的选项。
此方式始终从源代码构建。
从源代码安装时默认选择 zerocode,并允许您更改应用选择。
源路径还允许你选择可选的 Cargo 特性。
如果需要从源代码构建,且系统中缺少 Rust,安装程序可以自动安装 Rust。
在 Unix 上,安装程序会在允许的情况下更新 shell 配置文件;在依赖新的 PATH 之前,请重新加载父 shell。
对于未配置的安装,它提供 zeroclaw quickstart 或基于浏览器的快速入门。
Windows
cargo install --locked --path .
此路由为非交互式,不会打开选择器。
此方式始终从源代码构建。
此命令会安装核心 zeroclaw 二进制文件;不会安装可选应用。
该命令使用固定的特征集。
使用此命令前需要安装 Rust 工具链。
此 Cargo 命令不会修改 PATH;请确保 Cargo 的 bin 目录已在 shell 中可用。
安装后,运行 zeroclaw quickstart。
步骤
**重要提示:**如果您对以下任何术语感到陌生,请先阅读 Getting Started → Concepts。该文档在同一位置定义了模型提供商、风险配置文件、别名等概念。
每个界面都遵循相同的检查清单并写入相同的配置。必需步骤必须满足后才能创建该代理;可选步骤可以跳过。
| 步骤 | 必填 | 设置内容 |
|---|---|---|
| 模型提供商 | 是 | 提供商系列(Anthropic、OpenAI、Ollama、OpenRouter 等)、其 API 密钥或端点以及模型。 |
| 风险概况 | 是 | 自主性与沙箱配置。选择一个预设或复用现有的 [risk_profiles.<alias>]。 |
| 内存 | 是 | 内存后端(sqlite、markdown、postgres、qdrant、lucid 或 none)。 |
| 通道 | 可选 | 聊天平台(Telegram、Discord、Slack 等)。内置的 cli 通道始终可用;可在此处或稍后添加其他平台。 |
| 对等组 | 可选 | 您配置的频道的多代理对等成员资格。 |
| Agent | 是 | Agent 别名、系统提示词以及任何个性化文件。 |
运行时配置文件会自动设置。Quickstart 会为新代理安装
unbounded预设。之后可通过编辑[runtime_profiles.<alias>]来调整预算和超时设置(参见 Reference → Config)。
命令行界面
在无头机器上或通过 SSH 操作时最快的路径:
sh
zeroclaw quickstart
你可以在终端中每步回答一个提示。内置的 cli 通道可立即使用,因此可以跳过 Channels 和 Peer groups。如需全部使用默认值、无需审批的配置,请参阅 YOLO mode。
OpenAI Codex 订阅认证
Quickstart 可以在无需 API key 的情况下配置 OpenAI Codex 订阅路径。先进行一次身份验证,然后在提示时选择 OpenAI 作为提供方,并将 Authentication 设置为 codex:
# 如果你已经使用 Codex CLI 登录:
zeroclaw auth login --model-provider openai-codex --import ~/.codex/auth.json
# 或启动 ZeroClaw 自己的 OpenAI Codex 登录流程:
zeroclaw auth login --model-provider openai-codex
对于脚本化设置,openai-codex 被接受为快速入门输入别名,并会写入规范的 [providers.models.openai.<alias>] 条目:
zeroclaw quickstart --model-provider openai-codex --model gpt-5.4 --agent assistant
Claude 订阅设置令牌认证
Quickstart 也可以使用普通的 Console API key 或 Claude Max 生成的 token 来配置 Claude/Anthropic:
claude setup-token
zeroclaw quickstart --model-provider anthropic --model claude-sonnet-4-5 --agent assistant
选择 Anthropic,将 Authentication 设置为 setup_token,然后把 claude setup-token 中的令牌粘贴到 API key/token 提示中。脚本化输入可以使用 --model-provider claude 作为别名。Quickstart 仍会写入规范的 [providers.models.anthropic.<alias>] 条目;该令牌通过与 api_key 相同的凭据路径存储。
zerocode
在 zerocode 终端界面中,Quickstart 窗格是其中一个选项卡。使用键盘来操作它:
切换到 Quickstart 窗格:
| 密钥 | 操作 |
|---|---|
Alt+← / Alt+b | 上一个窗格 |
Alt+→ / Alt+f | 下一个窗格 |
窗格内:
| 密钥 | 操作 |
|---|---|
k / ↑ | prev |
j / ↓ | 下一个 |
Enter | 打开 |
q / Esc | 离开 |
c / C | 创建代理 |
鼠标同样可用:单击模式栏中的标签页可切换窗格,单击某个步骤可选中并打开它,滚动则可在列表中移动浏览。
每个步骤都会打开一个与上述清单相对应的模态框,其中包含一个“使用现有”选项,该选项会列出配置中已匹配的别名。
Web 网关
在守护进程运行的情况下,在浏览器中打开仪表板:
sh
zeroclaw daemon
zeroclaw daemon 运行完整的运行时:网关、你配置的通道、调度器以及心跳监视器。(如果你只需要 HTTP 网关,可使用 zeroclaw gateway 仅启动它。)
然后访问 http://127.0.0.1:42617/quickstart。全新安装且未配置任何 agent 时会自动重定向到该页面;之后你随时可以从仪表板导航中访问它。
Web 表单以卡片形式呈现相同的步骤。提交时,它会通过守护进程应用你的提交内容(POST /api/quickstart/apply),如果有任何无效内容,将返回结构化的错误列表,然后就地重新加载守护进程,使新代理无需重启即可生效。另有一个独立的 POST /api/quickstart/validate 端点,可在不应用的情况下运行相同的检查,供希望先验证的客户端使用。