Ayuriel/openclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add API key prereq, first-message step, fix landing page quick start

Browse Source
This commit is contained in:
Vincent Koc 2026-03-19 10:28:44 -07:00
parent 65a2917c8f
commit 1dd857f6a6
2 changed files with 22 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/index.md
View File

@ -106,15 +106,19 @@ The Gateway is the single source of truth for sessions, routing, and channel con
openclaw onboard --install-daemon
```
</Step>
<Step title="Pair WhatsApp and start the Gateway">
<Step title="Chat">
Open the Control UI in your browser and send a message:
```bash
openclaw channels login
openclaw gateway --port 18789
openclaw dashboard
```
Or connect a channel ([Telegram](/channels/telegram) is fastest) and chat from your phone.
</Step>
</Steps>
Need the full install and dev setup? See [Quick start](/start/quickstart).
Need the full install and dev setup? See [Getting Started](/start/getting-started).
## Dashboard

39
docs/start/getting-started.md
View File

@ -20,9 +20,11 @@ Docs: [Dashboard](/web/dashboard) and [Control UI](/web/control-ui).
## Prereqs
- Node 24 recommended (Node 22 LTS, currently `22.16+`, still supported for compatibility)
- An API key from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you for this
<Tip>
Check your Node version with `node --version` if you are unsure.
Windows users: WSL2 is strongly recommended. See [Windows](/platforms/windows).
</Tip>
## Quick setup (CLI)
@ -73,34 +75,21 @@ Check your Node version with `node --version` if you are unsure.
```bash
openclaw dashboard
```
If the Control UI loads, your Gateway is ready.
</Step>
<Step title="Send your first message">
The fastest way to chat is directly in the Control UI browser tab.
Type a message and you should get an AI reply.
Want to chat from a messaging app instead? The fastest channel setup
is usually [Telegram](/channels/telegram) (just a bot token, no QR
pairing). See [Channels](/channels) for all options.
</Step>
</Steps>
<Check>
If the Control UI loads, your Gateway is ready for use.
</Check>
## Optional checks and extras
<AccordionGroup>
<Accordion title="Run the Gateway in the foreground">
Useful for quick tests or troubleshooting.
```bash
openclaw gateway --port 18789
```
</Accordion>
<Accordion title="Send a test message">
Requires a configured channel.
```bash
openclaw message send --target +15555550123 --message "Hello from OpenClaw"
```
</Accordion>
</AccordionGroup>
## Useful environment variables
If you run OpenClaw as a service account or want custom config/state locations: