快速开始与设置
安装、引导流程与早期故障问答。有关提供商认证、硬件以及 Gateway 的运行位置,请参阅 FAQ:提供商、硬件与托管。
快速开始与首次运行设置¶
推荐安装和设置 OpenClaw 的方式
安装程序会直接引导你完成设置流程,因此无需再单独运行 onboarding 命令。当引导流程结束后,按 Ctrl+C 停止前台 Gateway,然后安装后台服务:
更喜欢经典的分步向导,并希望一条命令同时完成服务安装?直接运行 openclaw onboard --install-daemon,无需再执行上面两条命令。该标志会选择经典流程,因此你不会看到引导式 Quick start(快速开始)和 Custom setup(自定义设置)这样的选择。
从源码构建(贡献者/开发者):
git clone https://github.com/openclaw/openclaw.git
cd openclaw
pnpm install
pnpm build
pnpm ui:build
openclaw onboard
尚未进行全局安装?请改为运行 pnpm openclaw onboard。如果缺少 Control UI 资源,引导流程会尝试自行构建,必要时回退到 pnpm ui:build。
我卡住了,最快的解决办法
请使用能够查看你机器的本地 AI 代理。大多数“我卡住了”的情况都属于本地配置或环境问题,远程助手无法检查这些,因此这样做比在 Discord 上提问更有效。
- Claude Code:https://www.anthropic.com/claude-code/
- OpenAI Codex:https://openai.com/codex/
通过可随意修改的(git)安装方式,将完整的源代码检出提供给代理,这样它就能阅读代码和文档,并针对你所运行的确切版本进行推理:
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --install-method git
请代理逐步规划并监督修复过程,然后只执行必要的命令——更小的 diff 更容易审计。
在寻求帮助时(Discord 或 GitHub issue 中),请分享以下输出:
| 命令 | 显示内容 |
|---|---|
openclaw status |
Gateway/代理健康状况 + 基本配置快照 |
openclaw status --all |
完整的只读诊断信息,可直接粘贴 |
openclaw models status |
提供商认证 + 模型可用性 |
openclaw doctor |
验证并修复常见的配置/状态问题 |
openclaw logs --follow |
实时日志尾部输出 |
openclaw gateway status --deep |
深度 Gateway/配置/插件健康检查 |
openclaw health --verbose |
详细健康报告 |
发现真正的 bug 或修复方案?请提交 issue 或发送 PR: Issues / Pull requests。
快速调试循环:如果出现问题,最初的 60 秒。 安装文档:安装、安装器标志、更新。
引导完成后如何打开仪表盘?
引导流程在设置完成后会立即在浏览器中打开一个干净的(不含令牌的)仪表盘 URL,并在摘要中输出该链接。请保持该标签页处于打开状态;如果它没有自动打开,请在同一台机器上复制/粘贴输出中的 URL。
如何在 localhost 与远程环境中认证仪表盘?
Localhost(同一台机器):
- 打开
http://127.0.0.1:18789/。 - 如果它要求共享密钥认证,请将配置好的令牌或密码粘贴到 Control UI 设置中。
- 令牌来源:
gateway.auth.token(或OPENCLAW_GATEWAY_TOKEN)。 - 密码来源:
gateway.auth.password(或OPENCLAW_GATEWAY_PASSWORD)。 - 尚未配置共享密钥?运行
openclaw doctor --generate-gateway-token(或openclaw doctor --fix --generate-gateway-token)。
不在 localhost 上:
- Tailscale Serve(推荐):保持绑定 loopback,运行
openclaw gateway --tailscale serve,打开https://<magicdns>/。设置gateway.auth.allowTailscale: true后,身份头即可满足 Control UI/WebSocket 认证(无需粘贴共享密钥,但假定网关主机可信);HTTP API 仍需要共享密钥认证,除非你特意使用 private-ingressnone或 trusted-proxy HTTP 认证。 来自同一客户端的并发错误认证 Serve 尝试会在失败认证限制器记录之前被串行化,因此第二次错误重试就可能显示retry later。 - 感知身份的反向代理:将 Gateway 放在受信任的代理后面,设置
gateway.auth.mode: "trusted-proxy",然后打开代理 URL。同一主机上的 loopback 代理需要显式设置gateway.auth.trustedProxy.allowLoopback: true。 - SSH 隧道:执行
ssh -N -L 18789:127.0.0.1:18789 user@gateway-host,然后打开http://127.0.0.1:18789/。共享密钥认证在隧道上仍然有效;如果提示,请粘贴配置好的令牌或密码。
心跳一直跳过。这些跳过原因是什么意思?
| 跳过原因 | 含义 |
|---|---|
quiet-hours |
不在配置的活动时间段窗口内 |
empty-heartbeat-file |
心跳监视器暂存文件存在,但其中只有空白、注释、标题、围栏或空检查清单等脚手架内容 |
alerts-disabled |
所有心跳可见性均已关闭(showOk、showAlerts 和 useIndicator 全部禁用) |
较旧的心跳 tasks: 配置块会通过 openclaw doctor --fix 迁移为独立调度的 cron 任务。
文档:Heartbeat、Automation。
为什么聊天审批有两个 exec 审批配置?
它们控制的是不同层面:
approvals.exec- 将审批提示转发到聊天目标。channels.<channel>.execApprovals- 使该频道成为 exec 审批的原生审批客户端。
主机执行策略仍然是真正的审批关口;聊天配置只控制提示出现在哪里以及人们如何回答它们。
你很少需要同时使用两者:
- 如果聊天已经支持命令和回复,同聊天的
/approve通过共享路径工作。 - 对于支持的原生客户端,设置
channels.<channel>.execApprovals.enabled: "auto"或true,并配置审批人或该频道支持的所有者身份。Discord 和 Slack 需要显式启用;Telegram 将未设置视为"auto"。 - 当原生审批卡片/按钮可用时,该 UI 是主要的;只有在工具结果说明聊天审批不可用时,才提及手动
/approve命令。 - 仅当提示还必须到达其他聊天或专用运维房间时,才使用
approvals.exec。 - 仅当你希望将审批提示发布回发起房间/主题时,才使用
channels.<channel>.execApprovals.target: "channel"或"both"。 - 插件审批是独立的:默认同聊天
/approve,可选的approvals.plugin转发,并且只有某些原生频道对这些也保持原生处理。
简短版本:转发用于路由,原生客户端配置用于更丰富的频道特定 UX。 参见 执行审批。
我需要什么运行时?
Node 24.16+ 或 26.1+ 是主要且默认的运行时(推荐 Node 26);维护要求请参阅 Node.js。pnpm 是仓库的包管理器。支持 WAL 重置安全的 node:sqlite 的 Bun 1.4+ 构建可以显式选择运行 CLI、Gateway 和托管节点主机。
它能运行在 Raspberry Pi 上吗?
能,但先检查内存:Pi 5 和 Pi 4(2 GB+)是最佳选择;Pi 3B+(1 GB)可用但较慢;Pi Zero 2 W(512 MB)不推荐。
| 型号 | 内存 | 适配 |
|---|---|---|
| Pi 5 | 4/8 GB | 最佳 |
| Pi 4 | 4 GB | 良好 |
| Pi 4 | 2 GB | 可以使用,增加 swap |
| Pi 4 | 1 GB | 紧张 |
| Pi 3B+ | 1 GB | 较慢 |
| Pi Zero 2 W | 512 MB | 不推荐 |
绝对最低要求:1 GB 内存、1 核、500 MB 可用磁盘、64 位操作系统。由于 Pi 只运行 Gateway(模型调用云端 API),即使是性能一般的 Pi 也能应对负载。
小型 Pi/VPS 也可以只托管 Gateway,同时在你的笔记本电脑/手机上配对节点,用于本地屏幕/摄像头或命令执行。配对的 Mac 还可以在其原生面板中显示托管的小部件。参见 节点。
完整设置指南:Raspberry Pi。
Raspberry Pi 安装有什么技巧吗?
- 使用 64 位操作系统;不要使用 32 位 Raspberry Pi OS。
- 在 2 GB 或更小的主板上增加 swap。
- 优先使用 USB SSD 而不是 SD 卡,以获得更好的性能和寿命。
- 推荐使用可 hack 的(git)安装方式,这样你可以查看日志并快速更新。
- 先不要配置频道/技能,逐个添加。
- 奇怪的二进制失败(“exec format error”)通常是可选的技能工具缺少 ARM64 构建。
完整指南:Raspberry Pi。另请参阅 Linux。
它卡在 “wake up my friend”/onboarding 无法孵化。现在怎么办?
该画面取决于 Gateway 是否可访问并通过身份验证。当配置了模型提供商时,TUI 还会在首次孵化时自动发送 “Wake up, my friend!”(醒醒,我的朋友!)。如果你跳过了模型/认证设置,onboarding 会显示 “Model auth missing”(缺少模型认证)提示,并打开 TUI 而不发送任何内容——再次运行 openclaw onboard 来添加提供商。这是更改模型提供商或其身份验证的唯一命令。如果你看到唤醒提示但没有回复,并且 tokens 保持为 0,说明 agent 从未运行。
- 重启 Gateway:
- 检查状态 + 认证:
- 仍然卡住?运行:
如果 Gateway 是远程的,请确认 tunnel/Tailscale 连接已建立,并且 UI 指向正确的 Gateway。参见 远程访问。
我可以将我的设置迁移到新机器而无需重新执行 onboarding 吗?
可以。复制状态目录和工作区,然后运行一次 Doctor:
- 在新机器上安装 OpenClaw。
- 从旧机器复制
$OPENCLAW_STATE_DIR(默认:~/.openclaw)。 - 复制你的工作区(默认:
~/.openclaw/workspace)。 - 运行
openclaw doctor并重启 Gateway 服务。
这会保留配置、认证配置文件、WhatsApp 凭据、会话和记忆——只要你复制了这两个位置,你的 bot 就会完全保持一致。在远程模式下,Gateway 主机拥有会话存储和工作区。
重要: 如果你只将工作区提交/推送到 GitHub,你备份的是记忆 + 引导文件,而不是会话历史或认证。这些位于 ~/.openclaw/ 下(例如 ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite)。
相关:迁移、磁盘上的位置、 Agent 工作区、Doctor、 远程模式。
在哪里可以看到最新版本的新内容?
查看 GitHub 变更日志: https://github.com/openclaw/openclaw/blob/main/CHANGELOG.md
最新条目在顶部。如果顶部部分是 Unreleased(未发布),那么下一个带日期的部分就是最新发布的版本。条目分组在 Highlights(亮点)、Changes(变更)、Fixes(修复)下(必要时还会包含 docs/其他部分)。
无法访问 docs.openclaw.ai(SSL 错误)
某些 Comcast/Xfinity 连接会通过 Xfinity Advanced Security 错误地阻止 docs.openclaw.ai。请禁用它或将 docs.openclaw.ai 加入白名单,然后重试。帮助我们解除阻止:https://spa.xfinity.com/check_url_status
仍然无法访问?文档已镜像到 GitHub: https://github.com/openclaw/openclaw/tree/main/docs
stable 与 beta 的区别
Stable 和 beta 是 npm dist-tags,并非独立的代码分支:
latest= stablebeta= 用于测试的早期构建(当 beta 缺失或早于当前 stable 版本时,会回退到latest)
稳定版通常先发布到 beta,然后通过显式的提升步骤将该版本提升到 latest,版本号不变。
维护者也可以直接发布到 latest。这就是为什么提升后 beta 和 stable 可能指向同一版本。
查看变更内容:CHANGELOG.md。
有关一键安装命令以及 beta 与 dev 的区别,请参阅下一个折叠面板。
如何安装 beta 版本?beta 与 dev 有什么区别?
Beta 是 npm dist-tag beta(提升后可能与 latest 相同)。
Dev 是 main(git)分支的最新提交;发布到 npm 时使用 dist-tag dev。
一键安装命令(macOS/Linux):
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --install-method git
Windows 安装程序(PowerShell):iwr -useb https://openclaw.ai/install.ps1 | iex
如何体验最新版本?
两种方式:
- Dev 渠道(现有安装):
这会切换到 main 的 git checkout,基于上游进行 rebase,然后构建并从该 checkout 安装 CLI。
- 可修改式(git)安装(新机器):
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --install-method git
更喜欢手动克隆:
安装和初始化通常需要多长时间?
大致参考:
- 安装: 2-5 分钟。
- QuickStart 初始化: 几分钟(回环网关、自动 Token、默认工作区)。
- 高级/完整初始化: 如果提供商登录、渠道配对、守护进程安装、网络下载或技能需要额外设置,所需时间会更长。
向导会预先显示此时间线。可跳过可选步骤,稍后使用 openclaw configure 再回来配置。
卡住了?请参阅上文的 我卡住了。
安装程序卡住了?如何获取更多反馈?
使用 --verbose 重新运行:
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --verbose
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --beta --verbose
curl -fsSL --proto '=https' --tlsv1.2 https://openclaw.ai/install.sh | bash -s -- --install-method git --verbose
install.ps1 没有专用的 verbose 开关;请改用 Set-PSDebug -Trace 1 / -Trace 0 包裹运行。完整标志参考:安装程序标志。
Windows 安装提示找不到 git 或无法识别 openclaw
两个常见的 Windows 问题:
1) npm 错误:spawn git / 找不到 git
- 安装 Git for Windows,并确保
git已在 PATH 中。 - 关闭并重新打开 PowerShell,然后重新运行安装程序。
2) 安装后无法识别 openclaw
- 你的 npm 全局 bin 文件夹不在 PATH 中。
- 检查方法:
npm config get prefix。 - 将该目录添加到你的用户 PATH(无需
\bin后缀;在大多数系统上它是%AppData%\npm)。 - 关闭并重新打开 PowerShell。
更喜欢桌面应用?请使用 Windows Hub。仅终端的安装方式:PowerShell 安装程序和 WSL2 Gateway 路径均受支持。文档:Windows。
Windows 上 exec 输出显示中文乱码 - 我该怎么办?
通常是原生 Windows shell 上的控制台代码页不匹配导致的。
症状:system.run/exec 的输出中中文显示为乱码;同样的命令在其他终端配置中看起来正常。
PowerShell 中的解决方法:
chcp 65001
[Console]::InputEncoding = [System.Text.UTF8Encoding]::new($false)
[Console]::OutputEncoding = [System.Text.UTF8Encoding]::new($false)
$OutputEncoding = [System.Text.UTF8Encoding]::new($false)
然后重启 Gateway 并重试:
在最新版 OpenClaw 上仍能复现?请跟踪/报告:Issue #30640。
文档没有回答我的问题 - 如何获得更好的答案?
使用可修改式(git)安装,这样你就可以在本地获得完整源代码和文档,然后在该文件夹中向你的机器人(或 Claude/Codex)提问,这样它就能阅读仓库并准确回答。
如何在 VPS 上安装 OpenClaw?
任何 Linux VPS 都可以。在服务器上安装后,通过 SSH/Tailscale 访问 Gateway 即可。
指南:exe.dev、Hetzner、Fly.io。 远程访问:Gateway 远程访问。
云/VPS 安装指南在哪里?
包含常见提供商的托管中心:
在云端,Gateway 运行在服务器上,你可以通过 Control UI(或 Tailscale/SSH)从笔记本电脑/手机访问它。你的状态 + 工作区保存在服务器上,因此请将主机视为唯一事实来源并做好备份。
将节点(Mac/iOS/Android/headless)配对到该云 Gateway,即可在 Gateway 保持云端运行的同时,在你的笔记本电脑上执行本地屏幕/相机或命令。
中心:平台。远程访问:Gateway 远程访问。 节点:节点、节点 CLI。
我可以让 OpenClaw 自我更新吗?
可以,但不推荐。更新流程可能会重启 Gateway(中断当前会话),可能需要干净的 git checkout,并且可能会提示确认。更安全的做法是由操作员从 shell 运行更新。
openclaw update
openclaw update status
openclaw update --channel beta
openclaw update --tag 2026.9.3
openclaw update --no-restart
--channel 接受 stable、extended-stable、beta 或 dev。--tag 接受 npm dist-tag 或精确版本号。
通过智能体自动化:
Onboarding 实际上做了什么?
openclaw onboard 是推荐的设置路径。在全新的本地安装中,它会先显示一行指向安全指南的提示,然后提供两条路径:
- 快速开始会检测你已有的 AI 访问方式,等待你选择一种连接,通过一次真实的补全来验证该选择,准备智能体工作区,然后在前台启动 Gateway 并打开浏览器仪表盘。它使用默认智能体名称
main和完全访问权限,并跳过记忆导入和应用推荐。在选择器中选择暂时跳过即可准备本地基线并退出,而不会启动 Gateway 或 AI 聊天。 - 自定义设置运行相同的引导流程,但会将遥测选择、智能体名称、访问模式以及可选设置提示保留为问答形式。
两条路径都要求先明确选择提供商,然后才会进行任何实际补全、提供商安装、模型选择或凭据写入。
经典的逐步向导仍然可用。运行 openclaw onboard --classic 可查看其 Workspace、Model/Auth、Gateway、Channels、Web search、Skills、Daemon 和 Health check 步骤。步骤列表见 Onboarding (CLI)。
对于已配置的安装、远程 Gateway 聊天设置、非交互式运行,或使用 --skip-ui 或 --tui 的运行,不提供快速开始选项。
完整说明:Onboarding (CLI)。
运行它需要 Claude 或 OpenAI 订阅吗?
不需要。使用 API 密钥(Anthropic/OpenAI/其他)或仅本地模型运行 OpenClaw,即可让数据保留在你的设备上。订阅(Claude Pro/Max、ChatGPT/Codex)只是为这些提供商进行认证的可选方式。
对于 Anthropic:API 密钥提供标准的按量付费计费;Claude CLI 会复用同一主机上已有的 Claude Code 登录。Anthropic 目前将 Claude CLI 的非交互式 claude -p 路径视为 Agent SDK/编程式使用,仍会消耗你订阅的计划额度——在依赖订阅行为之前,请查阅最新的 Anthropic 计费文档。对于长期运行的 gateway 主机和共享自动化,Anthropic API 密钥是更可预测的选择。
OpenAI Codex OAuth(ChatGPT/Codex 订阅)完全支持用于智能体模型。OpenClaw 还支持托管的订阅式选项,包括 Qwen Cloud Coding Plan、MiniMax Coding Plan 和 Z.AI / GLM Coding Plan。
我可以在没有 API 密钥的情况下使用 Claude Max 订阅吗?
可以。OpenClaw 支持为 Pro/Max/Team/Enterprise 计划复用 Claude CLI。Anthropic 目前将 OpenClaw 使用的 claude -p 路径视为订阅计划用量,受你计划额度的限制,而不是单独的免费额度——有关当前的计费详情以及 Anthropic 官方支持文章的链接,请参阅 Anthropic。对于最可预测的服务器端设置,请改用 Anthropic API 密钥。
你们支持 Claude 订阅认证(Claude Pro 或 Max)吗?
支持,通过复用 Claude CLI 实现。Anthropic 对 claude -p/Agent SDK 使用的计费处理方式随时间有所变化;在依赖具体计费行为之前,请参阅 Anthropic 了解当前状态以及带日期的 Anthropic 支持文章链接。
Anthropic 的 setup-token 认证仍然是一条受支持的 token 路径,但 OpenClaw 更倾向于在可用时复用 Claude CLI 和 claude -p。对于生产环境或多用户工作负载,Anthropic API 密钥仍然是更安全、更可预测的选择。其他订阅式托管选项:OpenAI、Qwen Cloud、MiniMax、Z.AI (GLM)。
推理努力:绝对最大,不允许走捷径。 你必须非常彻底地思考,全面分解问题以找到根本原因,对所有潜在路径、边界情况和对抗性场景进行严格的压力测试。 明确写出你的整个推演过程,记录每一个中间步骤、考虑过的替代方案和已否决的假设,以确保绝对没有任何假设被遗漏。
你是一名专业的技术文档翻译人员。将用户的 Markdown 翻译成简体中文。 规则: - 保持所有代码块、行内代码、URL、HTML 标签和 Markdown 结构不变。仅翻译散文文本(以及块引用/列表项/表格单元格中的散文)。 - 不要翻译代码标识符、命令、文件路径、API 名称或品牌/产品名称(例如 Ollama、Docker、GPU、REST、JSON、Token、Prompt、Claude Code)。 - 保留标题级别;对于每个标题,通过 attr_list 附加其原始英文锚点,例如 "## Install Guide" -> "## 安装指南 {#install-guide}"(slug = 小写单词以连字符连接,来自原始英文标题)。 - 仅输出翻译后的 Markdown,无前言,整个输出周围不要有代码围栏。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw