Skip to content
RemoteClaw

Getting Started

Getting Started

Goal: go from zero to a first working chat with minimal setup.

Fastest chat: open the Control UI (no channel setup needed). Run remoteclaw dashboard and chat in the browser, or open http://127.0.0.1:18789/ on the

gateway host. Docs: Dashboard and Control UI. :::

Prereqs

  • Node 22 or newer

Check your Node version with node --version if you are unsure.

Quick setup (CLI)

  1. Install RemoteClaw (recommended)

    Terminal window
    curl -fsSL https://remoteclaw.org/install.sh | bash
    Install Script Process

    Other install methods and requirements: Install.

  2. Run the onboarding wizard

    Terminal window
    remoteclaw onboard --install-daemon

    The wizard configures auth, gateway settings, and optional channels. See Setup for details.

  3. Check the Gateway

    If you installed the service, it should already be running:

    Terminal window
    remoteclaw gateway status

  4. Open the Control UI

    Terminal window
    remoteclaw dashboard

Success

If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Run the Gateway in the foreground

Useful for quick tests or troubleshooting.

Terminal window
remoteclaw gateway --port 18789
Send a test message

Requires a configured channel.

Terminal window
remoteclaw message send --target +15555550123 --message "Hello from RemoteClaw"

Useful environment variables

If you run RemoteClaw as a service account or want custom config/state locations:

  • REMOTECLAW_HOME sets the home directory used for internal path resolution.
  • REMOTECLAW_STATE_DIR overrides the state directory.
  • REMOTECLAW_CONFIG_PATH overrides the config file path.

Full environment variable reference: Environment vars.

Go deeper

Setup

Setup — Full setup reference and advanced options.

Configuration

Configuration — Gateway configuration reference.

What you will have

  • A running Gateway
  • Auth configured
  • Control UI access or a connected channel

Next steps

  • DM safety and approvals: Pairing
  • Connect more channels: Channels
  • Advanced workflows and from source: Setup