Appearance
openclaw setup 命令用于在首次部署时初始化 openclaw.json 和智能体工作区,适用于可变配置安装。不带任何向导参数时,只生成基线配置;带上 --wizard、--mode、--import-from 等任意一个向导 flag,会自动启动完整引导流程。注意:Nix 模式下(OPENCLAW_NIX_MODE=1)OpenClaw 拒绝写入配置,改用 Nix 包管理。
openclaw setup:初始化配置与向导触发教程
初始化基线配置文件(~/.openclaw/openclaw.json)和 Agent 工作区。如果检测到任何向导相关的 flag,还会自动运行交互式引导流程。
INFO
openclaw setup 仅适用于可变配置安装。在 Nix 模式下(设置了 OPENCLAW_NIX_MODE=1),OpenClaw 拒绝写入配置,因为配置文件由 Nix 管理。请使用第一方 nix-openclaw Quick Start 或其他 Nix 包的等效源配置。
选项
| Flag | 描述 |
|---|---|
--workspace <dir> | 指定 Agent 工作区目录(默认 ~/.openclaw/workspace;存储在 agents.defaults.workspace)。 |
--wizard | 运行交互式引导流程。 |
--non-interactive | 运行引导流程时不弹出交互提示。 |
--mode <mode> | 引导模式:local 或 remote。 |
--import-from <provider> | 在引导期间使用的迁移提供程序。 |
--import-source <path> | --import-from 指定的源智能体家目录。 |
--import-secrets | 在引导迁移期间导入支持的密钥。 |
--remote-url <url> | 远程 Gateway 的 WebSocket URL。 |
--remote-token <token> | 远程 Gateway 的 token(可选)。 |
向导自动触发
只要显式指定了以下任意一个 flag(即使不带 --wizard),openclaw setup 都会自动启动向导:
--wizard、--non-interactive、--mode、--import-from、--import-source、--import-secrets、--remote-url、--remote-token
示例
bash
openclaw setup
openclaw setup --workspace ~/.openclaw/workspace
openclaw setup --wizard
openclaw setup --wizard --import-from hermes --import-source ~/.hermes
openclaw setup --non-interactive --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>注意事项
- 仅执行
openclaw setup时,只会初始化配置和工作区,不会运行完整的引导流程。 - 执行
openclaw setup后,如果需要完整交互式引导,运行openclaw onboard;需要局部调整,运行openclaw configure;需要添加渠道账号,运行openclaw channels add。 - 如果检测到 Hermes 状态,交互式引导可以自动提供迁移选项。带
--import-from的迁移引导要求全新 setup;如需在引导之外进行试运行计划、备份和覆盖模式,请参考 Migrate。
相关文档
常见问题
如何用 openclaw setup 开始配置 OpenClaw?
首次部署时,直接运行 openclaw setup 即可初始化 ~/.openclaw/openclaw.json 和默认智能体工作区。如果想走完整引导流程,带上 --wizard,系统会一步步提示你完成工作区、渠道和智能体设置。
openclaw setup 怎么自动触发向导?
只要在命令中显式带上 --wizard、--non-interactive、--mode、--import-from、--import-source、--import-secrets、--remote-url、--remote-token 中任意一个 flag,即使没有直接写 --wizard,setup 也会自动启动交互式或非交互式引导流程。
openclaw setup 为什么在 Nix 模式下不工作?
因为在 Nix 模式下环境变量 OPENCLAW_NIX_MODE=1 生效,配置文件由 Nix 管理,setup 命令会拒绝写入。这种情况请使用 nix-openclaw Quick Start 或你所用 Nix 包的等效配置方式。