alvis
bedb527145
Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
79 lines
4.8 KiB
Markdown
79 lines
4.8 KiB
Markdown
---
|
|
summary: "CLI reference for `openclaw setup` (alias for onboarding, with baseline setup available by flag)"
|
|
read_when:
|
|
- You're doing first-run setup with the CLI onboarding wizard
|
|
- You want to set the default workspace path
|
|
- You need the baseline-only setup flag for scripts
|
|
title: "Setup"
|
|
---
|
|
|
|
# `openclaw setup`
|
|
|
|
`openclaw setup` runs the same guided onboarding flow as `openclaw onboard`
|
|
(auth, workspace, Gateway, channels, skills, health). Use `--baseline` when you
|
|
only need to initialize config/workspace folders without the wizard.
|
|
|
|
`setup` accepts the same onboarding flags as `openclaw onboard`, including
|
|
auth (`--auth-choice`, `--token`, provider key flags), Gateway
|
|
(`--gateway-port`, `--gateway-bind`, `--gateway-auth`, `--install-daemon`),
|
|
Tailscale (`--tailscale`), reset (`--reset`, `--reset-scope`), flow
|
|
(`--flow quickstart|advanced|manual|import`), and skip flags
|
|
(`--skip-channels`, `--skip-skills`, `--skip-bootstrap`, `--skip-search`,
|
|
`--skip-health`, `--skip-ui`, `--skip-hooks`). See [Onboard](/cli/onboard) and
|
|
[CLI automation](/start/wizard-cli-automation) for the full flag reference and
|
|
non-interactive examples; `openclaw onboard --modern` (the Crestodian
|
|
conversational assistant) has no `setup` equivalent.
|
|
|
|
<Note>
|
|
`openclaw setup` is for mutable config installs. In Nix mode (`OPENCLAW_NIX_MODE=1`) OpenClaw refuses setup writes because the config file is managed by Nix. Use the first-party [nix-openclaw Quick Start](https://github.com/openclaw/nix-openclaw#quick-start) or the equivalent source config for another Nix package.
|
|
</Note>
|
|
|
|
## Options
|
|
|
|
| Flag | Description |
|
|
| -------------------------- | --------------------------------------------------------------------------------------------------- |
|
|
| `--workspace <dir>` | Agent workspace directory (default `~/.openclaw/workspace`; stored as `agents.defaults.workspace`). |
|
|
| `--baseline` | Create baseline config/workspace/session folders without onboarding. |
|
|
| `--wizard` | Accepted for compatibility; setup runs onboarding by default. |
|
|
| `--non-interactive` | Run onboarding without prompts. |
|
|
| `--accept-risk` | Acknowledge full-system agent access risk; required with `--non-interactive`. |
|
|
| `--mode <mode>` | Onboarding mode: `local` or `remote`. |
|
|
| `--flow <flow>` | Onboard flow: `quickstart`, `advanced`, `manual`, or `import`. |
|
|
| `--reset` | Reset config + credentials + sessions before onboarding (workspace only with `--reset-scope full`). |
|
|
| `--reset-scope <scope>` | Reset scope: `config`, `config+creds+sessions`, or `full`. |
|
|
| `--import-from <provider>` | Migration provider to run during onboarding. |
|
|
| `--import-source <path>` | Source agent home for `--import-from`. |
|
|
| `--import-secrets` | Import supported secrets during onboarding migration. |
|
|
| `--remote-url <url>` | Remote Gateway WebSocket URL. |
|
|
| `--remote-token <token>` | Remote Gateway token (optional). |
|
|
| `--json` | Output a JSON summary. |
|
|
|
|
### Baseline mode
|
|
|
|
`openclaw setup --baseline` preserves the older baseline-only behavior: it
|
|
creates the config, workspace, and session directories, then exits without
|
|
running onboarding.
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
openclaw setup
|
|
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>
|
|
```
|
|
|
|
## Notes
|
|
|
|
- After baseline setup, run `openclaw setup` or `openclaw onboard` for the full guided journey, `openclaw configure` for targeted changes, or `openclaw channels add` to add channel accounts.
|
|
- If Hermes state is detected, interactive onboarding can offer migration automatically. Import onboarding requires a fresh setup; use [Migrate](/cli/migrate) for dry-run plans, backups, and overwrite mode outside onboarding.
|
|
|
|
## Related
|
|
|
|
- [CLI reference](/cli)
|
|
- [Onboard](/cli/onboard)
|
|
- [Onboarding (CLI)](/start/wizard)
|
|
- [Getting started](/start/getting-started)
|
|
- [Install overview](/install)
|