跳转至

openclaw setup

openclaw setup 是系统代理的入口点。在已配置的系统上,单独运行 openclaw setup 会打开一个交互式 OpenClaw 聊天。在新系统上,它会回退到引导式初始化。使用 -m/--message 处理单个请求,或使用 --baseline 在不启动向导的情况下初始化配置/工作区文件夹。

路由顺序:

  1. 任何初始化选项(--wizard、--baseline、工作区、重置、非交互、流程、模式、Gateway、守护进程、跳过、导入、远程或认证选项)都会以与 openclaw onboard 完全相同的方式运行初始化。
  2. -m/--message 或 --yes 会运行系统代理。
  3. 如果没有路由选项,已配置的交互式系统会打开 OpenClaw。新系统会运行初始化。在已配置的系统上,--json 即使没有 TTY 也会打印系统概览;初始化选项会保留初始化的 JSON 摘要。

在引导模式下,--workspace <dir> 是提供给 OpenClaw 的工作区提案;只有在你批准该提案后才会持久化。基线、经典和非交互式设置在全新安装时会通过各自的正常流程持久化所提供的工作区。当现有代理名册会被重新映射时,经典向导要求显式确认;非交互式设置会保留当前代理群工作区并打印警告。

引导式推理检测在 macOS 或 Linux 的 Gateway 主机上运行。CLI 和 macOS 应用调用同一个 Gateway 自带的检测器,该检测器会检查已配置的模型、受支持的 CLI 登录、API 密钥环境变量,以及已安装的 Ollama 或 LM Studio 模型。此发现过程绝不会下载本地模型。CLI 引导和 macOS 应用都会等你先选择连接,然后才进行测试。失败或取消的尝试绝不会自动选择另一个提供商。设置过程会先保存凭据,然后使用内存中的候选设置发送一轮无工具的确认对话。只有在该轮对话成功后,它才会保存提供商和模型配置。连接失败会保留凭据,并使配置保持不变。选择已保存的登录信息即可重试,无需再次登录。自定义端点设置在 Gateway 运行期间仍可重试;重启后,需要重新输入端点设置。

初始的 Claude Code 和 Codex 检测会检查可执行文件版本,而不会运行 auth-status 命令或启动应用服务器。可读的 Codex 凭据会作为已存储的证据被报告;在检测期间,当前登录状态仍未得到验证。已存储的凭据不会因为已验证订阅而优先于环境 API 密钥。

在 Control UI 中,模型设置也可以通过共享模型选择器从已安装的原生代理中选择模型。使用 会保存该模型及其运行时,而无需运行设置测试;认证和工具仍归属于原生代理。提供商的 测试并使用 仍然要求经过验证的无工具回复。Gemini CLI 和 Antigravity 不会作为检测到的设置路径提供。

setup 接受与 openclaw onboard 相同的初始化标志,包括认证(--auth-choice、--token、提供商密钥标志)、Gateway(--gateway-port、--gateway-bind、--gateway-auth、--install-daemon)、Tailscale(--tailscale)、重置(--reset、--reset-scope)、流程(--flow quickstart|advanced|manual|import)和跳过标志(--skip-channels、--skip-skills、--skip-bootstrap、--skip-search、--skip-health、--skip-ui、--skip-hooks)。传入 --tui 可使用与 openclaw onboard --tui 相同的终端面板。有关完整标志参考和非交互式示例,请参阅 Onboard 和 CLI 自动化。openclaw onboard --modern 仍然是同一个受推理门控的 OpenClaw 助手的兼容入口。

本地初始化默认会以 token 模式生成一个 Gateway 密钥,而不会要求你选择 token 或密码。现有的 password 模式配置会被保留。使用 --gateway-auth password 或 --gateway-password <value> 可显式选择密码;Tailscale Funnel 仍然要求使用密码模式。

使用 setup --team 可进行与 onboard --team 相同的小团队初始化。--agent-name <name> 为第一个代理命名;如果与 --team 一起使用,则为协调器命名。

Note

openclaw setup 用于可变配置安装。在 Nix 模式(OPENCLAW_NIX_MODE=1)下,OpenClaw 会拒绝 setup 写入操作,因为配置文件由 Nix 管理。请使用第一方 nix-openclaw Quick Start 或其他 Nix 包的等效源配置。

选项

标志 描述
-m, --message <text> 运行一个 OpenClaw 请求。
--yes 为单个 --message 请求批准持久化配置写入。
--workspace <dir> 工作区提案;现有代理群需要经典向导确认,并以非交互方式保留。
--baseline 在不进行初始化的情况下创建基线配置/工作区/会话文件夹。
--wizard 强制交互式初始化。
--classic 运行经典的多步初始化向导;不能与 --non-interactive 一起使用。
--agent-name <name> 第一个代理的名称(默认:main)。
--tui 使用终端面板而非浏览器交接。
--non-interactive 在没有提示的情况下运行初始化。
标志 描述
--accept-risk 确认全系统代理访问风险;与 --non-interactive 一起使用时必需。
--mode <mode> 入门模式:local 或 remote。
--flow <flow> 入门流程:quickstart、advanced、manual 或 import。
--reset 在入门前重置配置、凭据和会话(仅当使用 --reset-scope full 时重置工作区)。
--reset-scope <scope> 重置范围:config、config+creds+sessions 或 full。
--import-from <provider> 入门期间要运行的迁移提供方。
--import-source <path> --import-from 的源代理主目录。
--import-secrets 在入门迁移期间导入受支持的机密。
--remote-url <url> 远程 Gateway WebSocket URL。
--remote-token <token> 远程 Gateway token(可选)。
--remote-password <password> 远程 Gateway 密码(可选)。
--json 已配置系统:OpenClaw 概览。入门路由:入门摘要。

--classic 和 --non-interactive 互斥:classic 会打开带提示的向导,而非交互式设置使用自动化路径。 在交互式入门中,--remote-url、--remote-token 和 --remote-password 会预填远程 Gateway 步骤,并在该次运行中优先于已存储的远程值。请传入 token 或密码之一,不要同时传入两者。 更改 URL 不会复用已存储的凭据,除非您同时提供新的 token 或密码。交互式步骤会要求一个 Gateway secret,并将其存储为 gateway.remote.token;Gateway 接受任一字段。 凭据保持掩码显示,并使用向导所选的明文或 SecretRef 存储模式。--gateway-token、--gateway-token-ref-env 和 --gateway-password 用于配置本地 Gateway,在远程模式下无效。对于远程 token SecretRef,请设置 OPENCLAW_GATEWAY_TOKEN,并使用 --secret-input-mode ref 配合 --remote-token。

基线模式

openclaw setup --baseline 保留旧的仅基线行为:它会创建配置、工作区和会话目录,然后退出,而不运行入门。它接受 --workspace、--skip-bootstrap 以及无害的输出控制选项,但会拒绝显式的入门、Gateway、认证、重置或守护进程选项,而不是静默忽略它们。如果现有配置无效,基线设置会保留它,并要求您运行 openclaw doctor --fix 以在重试前应用受支持的修复。

使用 openclaw setup --baseline --skip-bootstrap 可创建目录,而不生成工作区 bootstrap 文件。这会持久化 agents.defaults.skipBootstrap: true 作为本地配置覆盖,保留现有工作区文件和包含的配置项,并在后续省略该标志的基线运行中保持启用。 如果 skipBootstrap 值本身来自 $include,请直接编辑该包含文件,而不是通过基线设置替换其指针。 如果同时更改 --workspace,请先更新包含的按代理工作区或精确工作区文件包含项;基线设置会在写入任何配置或工作区文件之前拒绝该组合更改。

示例

openclaw setup
openclaw setup -m "status"
openclaw setup -m "restart gateway" --yes
openclaw setup --json
openclaw setup --wizard
openclaw setup --baseline
openclaw setup --workspace ~/.openclaw/workspace
openclaw setup --import-from hermes --import-source ~/.hermes
openclaw setup --non-interactive --accept-risk --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>
openclaw setup --non-interactive --accept-risk --mode remote --remote-url wss://gateway-host:18789 --remote-password <password>

说明

  • 在交互式 OpenClaw 聊天中,configure skills、configure web search 和 configure gateway 会运行托管设置流程。open search wizard 和 open gateway wizard 会将凭据输入交给带掩码的终端向导。Gateway 设置仅限本地且仅配置;之后请在聊天中使用 restart gateway 或在终端中使用 openclaw gateway restart 重启。参见 openclaw setup 操作。
  • import memory 会将检测到的本地内存复制到现有默认代理工作区,而不导入配置、凭据或技能。请先完成入门;聊天会报告部分复制和失败复制,而不是假定成功。
  • 基线设置后,运行 openclaw onboard 进行完整引导旅程,运行 openclaw configure 进行针对性更改,或运行 openclaw channels add 添加频道账户。
  • 如果检测到 Hermes 状态,交互式入门可以自动提供迁移。导入入门需要全新设置;在入门之外,请使用 迁移 进行 dry-run 计划、备份和覆盖模式。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw