ZeroClaw 使用方式与启动指南
1. 先给结论最常见的三种启动方式目标推荐命令说明先把项目跑起来并完成配置zeroclaw onboard首次使用的首选路径只启动控制平面和 Web 控制台zeroclaw gateway会提供 Web API、WebSocket、Dashboard、Webhook启动完整长期运行态zeroclaw daemon会拉起 gateway、channels、scheduler、heartbeat如果你只想在当前仓库里本地体验不一定非要先全局安装也可以直接cargo run--release--onboard cargo run--release--gateway2. 运行前需要什么通用依赖Rust stable 工具链Git仅在某些场景需要依赖什么时候需要Node.js npm需要从源码构建 Web 控制台或web/dist过期/缺失时Visual Studio Build ToolsWindows 上做源码构建时Docker想用容器启动各消息平台 Token / API Key想接入 Telegram、Slack、Discord、WhatsApp 等时各家模型凭证想真正调用 LLM 时3. 当前仓库下的推荐启动路径你当前仓库位置是D:\longxia\zeroclaw3.1 Windows / PowerShell 下直接从源码运行cd D:\longxia\zeroclaw cargo build--release--locked cargo install--path.--force--locked zeroclaw onboard zeroclaw gateway配置完成后还可以这样用zeroclaw agent-m你好介绍一下你自己zeroclaw status zeroclaw doctor zeroclaw daemon3.2 不做全局安装直接运行仓库里的二进制cd D:\longxia\zeroclaw cargo run--release--onboard cargo run--release--gateway cargo run--release--agent-m你好3.3 Windows 的脚本化入口仓库还提供了setup.bat它更偏向 Windows 用户的一键安装/构建路径。4. 首次使用流程第一步初始化推荐执行zeroclaw onboard从src/main.rs和src/onboard/的实现看onboard会根据当前环境自动选择交互式向导快速脚本模式TUI onboarding你也可以显式指定zeroclaw onboard--quick--api-keysk-...--provideropenrouter zeroclaw onboard--tuizeroclaw onboard --channels-only zeroclaw onboard--reinit第二步启动控制面zeroclaw gatewayGateway 启动后主要提供DashboardREST APIWebSocket chatSSE event streamPairingWebhook 接口第三步开始使用助手zeroclaw agent zeroclaw agent-m帮我总结今天的日志第四步如需长期运行切换到 daemonzeroclaw daemon5. 配置与工作目录如何解析根据docs/reference/api/config-reference.md和src/config/schema.rs配置解析优先级大致为ZEROCLAW_WORKSPACE已持久化的 active workspace 标记默认~/.zeroclaw/config.toml默认情况下核心配置与数据会落在用户目录下的.zeroclaw。重要配置项最值得先关注的几个配置分组配置段作用顶层default_provider/default_model决定默认模型后端[gateway]控制 Web/API 监听地址、配对、限流[channels_config]控制外部消息渠道[memory]记忆后端、检索与快照[autonomy]/[security]安全级别、审批、OTP、E-stop、沙箱[cron]/[scheduler]定时任务和轮询[skills]技能加载[runtime]native / docker 运行时6. 默认行为要点6.1 Gateway 默认值从src/config/schema.rs看核心默认值是port 42617host 127.0.0.1require_pairing trueallow_public_bind false这意味着源码默认更偏向本地安全模式。6.2 容器和开发模板不完全一样dev/config.template.toml和 Docker 模板里为了容器使用会改成类似host [::]allow_public_bind truerequire_pairing false这说明“源码默认”“容器模板默认”是两套不同的运行姿态使用时不要混淆。6.3 Agent 默认行为从AgentConfig默认值可看出compact_context truemax_tool_iterations 10max_history_messages 50parallel_tools falsetool_dispatcher auto适合先求稳再逐步调大能力。6.4 Memory 默认行为从MemoryConfig默认值可看出backend sqliteauto_save true默认启用 hygieneembedding provider 默认是none也就是说默认更像“有结构化长期记忆但不强依赖向量服务”。7. 常见运行方式7.1 只做本地 CLI 助手zeroclaw onboard zeroclaw agent适合单机、命令行体验。7.2 需要 Web 控制台zeroclaw onboard zeroclaw gateway然后访问 Gateway 提供的 Dashboard。7.3 需要长期在线、多渠道运行zeroclaw onboard zeroclaw daemon适合真正当作个人 AI 助手常驻。7.4 只启动消息渠道zeroclaw channel start这个更像运行消息入口不等于完整控制面。7.5 只做健康检查或诊断zeroclaw status zeroclaw doctor zeroclaw doctor models7.6 使用桌面端Tauri 桌面端依赖本地 Gateway。这意味着正确理解是先启动 Gateway再启动桌面伴侣程序因为apps/tauri/tauri.conf.json明确把前端地址指向了http://127.0.0.1:42617/_app/8. Docker 启动方式8.1 最简单dockercompose up-ddocker-compose.yml已经定义了镜像环境变量数据卷端口映射健康检查8.2 你需要知道的容器默认点数据卷zeroclaw-data默认暴露端口42617健康检查命令zeroclaw status --formatexit-code8.3 容器适合什么想快速部署想和宿主系统隔离想更方便迁移数据卷9. Web 控制台如何构建这个项目的前端不是单独部署为 Node 服务而是build.rs检查web/dist如果npm可用且前端资源过期会尝试自动执行npm cinpm run build编译后的资源通过rust-embed嵌入到 Rust 二进制Gateway 在/_app/*下提供静态文件如果你发现 Dashboard 打不开最直接的修复路径是cdwebnpmcinpmrun buildcd..cargobuild--release--locked10. 开发者常用命令按AGENTS.md和仓库脚本最重要的验证命令是cargofmt--all----checkcargoclippy --all-targets ---Dwarningscargotest完整本地 CI./dev/ci.sh all快捷命令也可以走just fmt-check just lint justtest11. 日常使用建议如果你是第一次接触这个项目推荐顺序zeroclaw onboardzeroclaw gateway打开 Dashboardzeroclaw agent -m 你好再考虑接入消息平台、调度和外设如果你是开发者推荐顺序看src/main.rs看src/config/schema.rs看src/agent/看src/providers/、src/tools/、src/channels/最后看src/gateway/和web/如果你要长期部署推荐优先daemonservice installstatus/doctor成本限制pairing / OTP / sandbox12. 一句话启动建议如果你现在就要把这个项目用起来最现实的命令序列是cd D:\longxia\zeroclaw cargo build--release--locked cargo run--release--onboard cargo run--release--gateway如果想让它变成长期在线的完整助手则把最后一步改成cargo run--release--daemon