openclaw/docs/start/getting-started.md at 588d7133f5d37cabebfc887fcae57cb324ee13ba

mirror of https://github.com/openclaw/openclaw.git synced 2026-02-19 18:39:20 -05:00

Files

Seb Slight db137dd65d fix(paths): respect OPENCLAW_HOME for all internal path resolution (#12091 )

* fix(paths): respect OPENCLAW_HOME for all internal path resolution (#11995)

Add home-dir module (src/infra/home-dir.ts) that centralizes home
directory resolution with precedence: OPENCLAW_HOME > HOME > USERPROFILE > os.homedir().

Migrate all path-sensitive callsites: config IO, agent dirs, session
transcripts, pairing store, cron store, doctor, CLI profiles.

Add envHomedir() helper in config/paths.ts to reduce lambda noise.
Document OPENCLAW_HOME in docs/help/environment.md.

* fix(paths): handle OPENCLAW_HOME '~' fallback (#12091) (thanks @sebslight)

* docs: mention OPENCLAW_HOME in install and getting started (#12091) (thanks @sebslight)

* fix(status): show OPENCLAW_HOME in shortened paths (#12091) (thanks @sebslight)

* docs(changelog): clarify OPENCLAW_HOME and HOME precedence (#12091) (thanks @sebslight)

2026-02-08 16:20:13 -05:00

3.1 KiB

Raw 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.1 KiB Raw Blame History