> ## 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

# Getting Started

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

> [!NOTE]
>
> Fastest chat: no channel setup needed. Turn on the [web client](https://docs.wednesdayai.dev/next/admin/web/user-client.md)
> (`gateway.webClient.enabled: true`) and chat in the browser at `http://127.0.0.1:18789/v2/client/`.
> Run `wednesdayai dashboard` (or open `http://127.0.0.1:18789/` on the
> gateway host (The machine running the WednesdayAI gateway service.))
> to open Control UI v2, the operator console at the gateway root.
> Docs: [Dashboard](https://docs.wednesdayai.dev/next/admin/web/dashboard.md), [Control UI v2](https://docs.wednesdayai.dev/next/admin/web/control-ui-v2.md), and [Web client](https://docs.wednesdayai.dev/next/admin/web/user-client.md).

## Prereqs

* Node 24 or newer

> [!TIP]
>
> Check your Node version with `node --version` if you are unsure.

## Quick setup (CLI)

**1. Install WednesdayAI (recommended)**

> [tab] macOS/Linux
>
> ```bash theme={"dark"}
> curl -fsSL https://wednesdayai.dev/install.sh | bash
> ```
>
> ![Install Script Process](https://mintcdn.com/expansionxpartners/zs8LxhdBvaZG5WAK/media/fffdd1e92dc5-install-script.svg?fit=max\&auto=format\&n=zs8LxhdBvaZG5WAK\&q=85\&s=f7743627122489a11b7464c97ec54fa7)

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

> [!NOTE]
>
> Other install methods and requirements: [Install](https://docs.wednesdayai.dev/next/admin/install).

**2. Run the onboarding wizard**

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

The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](https://docs.wednesdayai.dev/next/users/start/wizard.md) for details.

**3. Check the Gateway**

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

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

**4. Open the Control UI**

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

> [!TIP]
>
> If the Control UI loads, your Gateway is ready for use.

## Optional checks and extras

> [accordion] Run the Gateway in the foreground
>
> Useful for quick tests or troubleshooting.
>
> ```bash theme={"dark"}
> wednesdayai gateway --port 18789
> ```

> [accordion] Send a test message
>
> Requires a configured channel.
>
> ```bash theme={"dark"}
> wednesdayai message send --target +15555550123 --message "Hello from WednesdayAI"
> ```

## Useful environment variables

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

* `OPENCLAW_HOME` sets the home directory used for internal path resolution.
* `OPENCLAW_STATE_DIR` overrides the state directory.
* `OPENCLAW_CONFIG_PATH` overrides the config file path.

Full environment variable reference: [Environment vars](https://docs.wednesdayai.dev/next/users/help/environment.md).

## Go deeper

> [card] [Onboarding Wizard (details)](https://docs.wednesdayai.dev/next/users/start/wizard.md)
>
> Full CLI wizard reference and advanced options.

> [card] [macOS app onboarding](https://docs.wednesdayai.dev/next/users/start/onboarding.md)
>
> First run flow for the macOS app.

## What you will have

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

## Next steps

* DM safety and approvals: [Pairing](https://docs.wednesdayai.dev/next/admin/channels/pairing.md)
* Connect more channels: [Channels](https://docs.wednesdayai.dev/next/admin/channels.md)
* Advanced workflows and from source: [Setup](https://docs.wednesdayai.dev/next/users/start/setup.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.