> ## Documentation Index
> Fetch the complete documentation index at: https://agdiai-597e782f.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

# Getting Started

Install Agdi, run onboarding, and chat with your AI assistant — all in
about 5 minutes. By the end you will have a running Gateway, configured auth,
and a working chat session.

## What you need

* **Node.js** — Node 24 recommended (Node 22.14+ also supported)
* **An API key** from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you

> [!TIP]
>
> Check your Node version with `node --version`.
> **Windows users:** both native Windows and WSL2 are supported. WSL2 is more
> stable and recommended for the full experience. See [Windows](https://agdiai-597e782f.mintlify.site/platforms/windows.md).
> Need to install Node? See [Node setup](https://agdiai-597e782f.mintlify.site/install/node.md).

## Quick setup

**1. Install Agdi**

> [tab] macOS / Linux
>
> ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
> curl -fsSL https://agdi.ai/install.sh | bash
> ```
>
> ![Install Script Process](https://mintcdn.com/agdiai-597e782f/dgz7lCmhpS3UpOxQ/assets/install-script.svg?fit=max\&auto=format\&n=dgz7lCmhpS3UpOxQ\&q=85\&s=5c5501d2b7c83b56d75b380f816309e3)

> [tab] Windows (PowerShell)
>
> ```powershell theme={"theme":{"light":"min-light","dark":"min-dark"}}
> iwr -useb https://agdi.ai/install.ps1 | iex
> ```

> [!NOTE]
>
> Other install methods (Docker, Nix, npm): [Install](https://agdiai-597e782f.mintlify.site/install.md).

**2. Run onboarding**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
agdi onboard --install-daemon
```

The wizard walks you through choosing a model provider, setting an API key,
and configuring the Gateway. It takes about 2 minutes.

See [Onboarding (CLI)](https://agdiai-597e782f.mintlify.site/start/wizard.md) for the full reference.

**3. Verify the Gateway is running**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
agdi gateway status
```

You should see the Gateway listening on port 18789.

**4. Open the dashboard**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
agdi dashboard
```

This opens the Control UI in your browser. If it loads, everything is working.

**5. Send your first message**

Type a message in the Control UI chat and you should get an AI reply.

Want to chat from your phone instead? The fastest channel to set up is
[Telegram](https://agdiai-597e782f.mintlify.site/channels/telegram.md) (just a bot token). See [Channels](https://agdiai-597e782f.mintlify.site/channels.md)
for all options.

## What to do next

> [card] [Connect a channel](https://agdiai-597e782f.mintlify.site/channels.md)
>
> WhatsApp, Telegram, Discord, iMessage, and more.

> [card] [Pairing and safety](https://agdiai-597e782f.mintlify.site/channels/pairing.md)
>
> Control who can message your agent.

> [card] [Configure the Gateway](https://agdiai-597e782f.mintlify.site/gateway/configuration.md)
>
> Models, tools, sandbox, and advanced settings.

> [card] [Browse tools](https://agdiai-597e782f.mintlify.site/tools.md)
>
> Browser, exec, web search, skills, and plugins.

> [accordion] Advanced: environment variables
>
> If you run Agdi as a service account or want custom paths:
>
> * `OPENCLAW_HOME` — home directory for internal path resolution
> * `OPENCLAW_STATE_DIR` — override the state directory
> * `OPENCLAW_CONFIG_PATH` — override the config file path
>
> Full reference: [Environment variables](https://agdiai-597e782f.mintlify.site/help/environment.md).


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