Skip to content
RemoteClaw

Setup

remoteclaw setup

Initialize the baseline config and agent workspace. With any onboarding flag present, also runs the wizard.

`remoteclaw setup` is for mutable config installs. In Nix mode (`REMOTECLAW_NIX_MODE=1`) RemoteClaw refuses setup writes because the config file is managed by Nix. Use the first-party [nix-remoteclaw Quick Start](https://github.com/remoteclaw/nix-remoteclaw#quick-start) or the equivalent source config for another Nix package.

Options

FlagDescription
--workspace <dir>Agent workspace directory (default ~/.remoteclaw/workspace; stored as agents.defaults.workspace).
--wizardRun interactive onboarding.
--non-interactiveRun onboarding without prompts.
--mode <mode>Onboarding mode: local or remote.
--import-from <provider>Migration provider to run during onboarding.
--import-source <path>Source agent home for --import-from.
--import-secretsImport supported secrets during onboarding migration.
--remote-url <url>Remote Gateway WebSocket URL.
--remote-token <token>Remote Gateway token (optional).

Wizard auto-trigger

remoteclaw setup runs the wizard when any of these flags are explicitly present, even without --wizard:

--wizard, --non-interactive, --mode, --import-from, --import-source, --import-secrets, --remote-url, --remote-token.

Examples

Terminal window
remoteclaw setup
remoteclaw setup --workspace ~/.remoteclaw/workspace
remoteclaw setup --wizard
remoteclaw setup --wizard --import-from hermes --import-source ~/.hermes
remoteclaw setup --non-interactive --mode remote --remote-url wss://gateway-host:18789 --remote-token <token>

Notes

  • Plain remoteclaw setup initializes config and workspace without running the full onboarding flow.
  • After plain setup, run remoteclaw onboard for the full guided journey, remoteclaw configure for targeted changes, or remoteclaw 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 for dry-run plans, backups, and overwrite mode outside onboarding.