> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wednesdayai.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

> Install WednesdayAI, run the gateway, and reach the control panel in under ten minutes.

# Getting started

This page takes you from zero to a running WednesdayAI gateway with the control panel accessible. Channel setup — connecting WhatsApp, Telegram, iMessage, and others — comes after the gateway is stable.

<Info>
  **Fastest path to a first chat:** once the gateway is running, open `http://127.0.0.1:18789/` in a browser on the same machine. The built-in control panel lets you chat with your AI without connecting any external channel first.
</Info>

## Requirements

* **Node.js 24 or newer** — the installer script installs it automatically if missing
* **macOS, Linux, or Windows (via WSL2)** — native Windows is supported but WSL2 is recommended
* About 500 MB free disk space (including node modules)

Check your Node version:

```bash theme={"dark"}
node --version
```

If it prints `v24.x.x` or higher you are ready. Otherwise let the installer handle it, or install via [nvm](https://github.com/nvm-sh/nvm) / [fnm](https://github.com/Schniz/fnm) first.

<Note>
  WhatsApp and Telegram require the gateway to run on **Node**, not Bun. Version-managed Node paths (nvm, fnm, volta) can break a background service after upgrades — `openclaw doctor` warns and offers to migrate to a system Node install.
</Note>

## Step 1 — Install

The installer script is the recommended path. It detects your Node version, installs or upgrades it if needed, installs the `openclaw` CLI globally, and launches the onboarding wizard.

<Tabs>
  <Tab title="macOS / Linux / WSL2">
    ```bash theme={"dark"}
    curl -fsSL https://wednesdayai.dev/install.sh | bash
    ```
  </Tab>

  <Tab title="Windows (PowerShell)">
    ```powershell theme={"dark"}
    iwr -useb https://wednesdayai.dev/install.ps1 | iex
    ```
  </Tab>

  <Tab title="npm (manual)">
    If you already have Node 24+ and prefer to manage the install yourself:

    ```bash theme={"dark"}
    npm install -g openclaw@latest
    ```

    Then run the onboarding wizard manually in Step 2.
  </Tab>
</Tabs>

<Accordion title="pnpm global install">
  pnpm needs an extra step to approve packages with native build scripts:

  ```bash theme={"dark"}
  pnpm add -g openclaw@latest
  pnpm approve-builds -g    # select openclaw, sharp, node-llama-cpp when prompted
  ```
</Accordion>

<Accordion title="sharp build errors on macOS">
  If `sharp` fails because you have libvips installed via Homebrew:

  ```bash theme={"dark"}
  SHARP_IGNORE_GLOBAL_LIBVIPS=1 npm install -g openclaw@latest
  ```
</Accordion>

## Step 2 — Run the onboarding wizard

If the installer completed successfully it already ran the wizard. After a manual npm install, run:

```bash theme={"dark"}
openclaw onboard --install-daemon
```

The wizard walks you through:

1. **Model and auth** — choose an AI provider and authenticate. It supports Anthropic (API key or `claude setup-token`) and OpenAI Codex (OAuth) among others. You can add more later via `openclaw onboard` or `openclaw models auth ...`.
2. **Gateway port** — defaults to `18789`. Change it here if that port is in use.
3. **System service** — `--install-daemon` installs the gateway as a background service so it starts at login. Recommended for persistent deployments.

<Note>
  Rerun the wizard at any time with `openclaw onboard`. Provider auth can also be added directly: `openclaw models auth paste-token --provider anthropic` or `openclaw models auth login --provider <provider>`.
</Note>

## Step 3 — Verify the gateway

```bash theme={"dark"}
openclaw gateway status
```

Expected:

```
✔ Gateway running  pid=12345  port=18789  uptime=0m 12s
```

If it is not running, start it:

<Tabs>
  <Tab title="Linux (systemd)">
    ```bash theme={"dark"}
    systemctl --user start openclaw-gateway
    systemctl --user status openclaw-gateway
    ```
  </Tab>

  <Tab title="macOS (menubar app)">
    Open the **WednesdayAI** menubar app and click **Start gateway**, or:

    ```bash theme={"dark"}
    openclaw gateway start
    ```
  </Tab>

  <Tab title="Foreground (any platform)">
    Useful for quick tests — press Ctrl-C to stop:

    ```bash theme={"dark"}
    openclaw gateway --port 18789
    ```
  </Tab>
</Tabs>

## Step 4 — Open the control panel

```bash theme={"dark"}
openclaw dashboard
```

This opens `http://127.0.0.1:18789/`. If the gateway runs on a remote server, see [Remote access](/admin/gateway/remote-access).

<Check>
  If the control panel loads and you can send a test message, your gateway is ready.
</Check>

## Step 5 — Run a health check

```bash theme={"dark"}
openclaw doctor
```

`openclaw doctor` validates your config, checks configured channels and providers, and reports missing credentials or unknown config keys. Fix any warnings before moving on.

```bash theme={"dark"}
openclaw doctor --fix    # auto-repair common issues
```

See [Doctor](/admin/doctor) for the full check list.

## What you have now

| Component      | Status                                  |
| -------------- | --------------------------------------- |
| `openclaw` CLI | Installed globally                      |
| Gateway        | Running as a background service         |
| Auth           | At least one AI provider connected      |
| Control panel  | Accessible at `http://localhost:18789/` |

## Next steps

<CardGroup cols={2}>
  <Card title="Gateway configuration" href="/admin/gateway/configuration" icon="settings">
    Tune port, bind, auth, model routing, and all other gateway settings.
  </Card>

  <Card title="Connect channels" href="/admin/channels" icon="plug">
    Add WhatsApp, Telegram, iMessage, Signal, Slack, Discord, and more.
  </Card>

  <Card title="AI providers" href="/admin/providers" icon="sparkles">
    API keys, OAuth, and model selection.
  </Card>

  <Card title="Remote access" href="/admin/gateway/remote-access" icon="globe">
    Reach the gateway securely from outside localhost.
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="`openclaw` command not found after install">
    The npm global bin directory is not in your PATH:

    ```bash theme={"dark"}
    echo 'export PATH="$(npm prefix -g)/bin:$PATH"' >> ~/.zshrc
    source ~/.zshrc
    openclaw --version
    ```
  </Accordion>

  <Accordion title="Gateway fails to start — port already in use">
    Change the port in `~/.openclaw/openclaw.json`:

    ```json theme={"dark"}
    { "gateway": { "port": 18790 } }
    ```

    Then restart: `systemctl --user restart openclaw-gateway` (Linux) or `openclaw gateway start` (macOS/manual).
  </Accordion>

  <Accordion title="Onboarding wizard exits without completing">
    The wizard requires an active TTY. Over SSH without a PTY, add `-t`:

    ```bash theme={"dark"}
    ssh -t user@host openclaw onboard
    ```

    Or complete the wizard locally and copy `~/.openclaw/openclaw.json` to the server.
  </Accordion>

  <Accordion title="`openclaw doctor` reports unknown config keys">
    Unknown top-level keys stop the gateway from starting. Remove them, or run `openclaw doctor --fix` (check the diff before restarting).
  </Accordion>
</AccordionGroup>