openclaw/docs/start/getting-started.md at main

mirror of https://github.com/openclaw/openclaw.git synced 2026-02-16 15:19:33 +00:00

Files

Seb Slight 3ed06c6f36 docs: modernize gateway configuration page (Phase 1) (#14111 )

* docs(configuration): split into overview + full reference with Mintlify components

* docs(configuration): use tooltip for JSON5 format note

* docs(configuration): fix Accordion closing tags inside list contexts

* docs(configuration): expand intro to reflect full config surface

* docs(configuration): trim intro to three concise bullets

* docs(configuration-examples): revert all branch changes

* docs(configuration): improve hot-reload section with tabs and accordion

* docs(configuration): uncramp hot-reload — subheadings, bullet list, warning

* docs(configuration): restore hot-apply vs restart table

* docs(configuration): fix hot-reload table against codebase

* docs: add configuration-reference.md — full field-by-field reference

* docs(gateway): refresh runbook and align config reference

* docs: include pending docs updates and install graphic

2026-02-11 10:44:34 -05:00

3.2 KiB

Raw Permalink Blame History

summary, read_when, title

summary

read_when

title

Get OpenClaw installed and run your first chat in minutes.

First time setup from zero

You want the fastest path to a working chat

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 `openclaw dashboard` and chat in the browser, or open `http://127.0.0.1:18789/` on the gateway host. Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).

Prereqs

Node 22 or newer

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

Quick setup (CLI)

```bash curl -fsSL https://openclaw.ai/install.sh | bash ```

```powershell iwr -useb https://openclaw.ai/install.ps1 | iex ```

<Note>
Other install methods and requirements: [Install](/install).
</Note>

```bash openclaw onboard --install-daemon ```

The wizard configures auth, gateway settings, and optional channels.
See [Onboarding Wizard](/start/wizard) for details.

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

```bash
openclaw gateway status
```

```bash openclaw dashboard ``` If the Control UI loads, your Gateway is ready for use.

Optional checks and extras

Useful for quick tests or troubleshooting.

```bash
openclaw gateway --port 18789
```

Requires a configured channel.

```bash
openclaw message send --target +15555550123 --message "Hello from OpenClaw"
```

Useful environment variables

If you run OpenClaw 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.

Go deeper

Full CLI wizard reference and advanced options. 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
Connect more channels: Channels
Advanced workflows and from source: Setup

3.2 KiB Raw Permalink Blame History