# openclaw/openclaw

378.7k

星标

79.2k

分支

378.7k

关注者

TypeScript

语言

## 📖 项目介绍

# 🦞 OpenClaw — Personal AI Assistant

**EXFOLIATE! EXFOLIATE!**

**OpenClaw** is a _personal AI assistant_ you run on your own devices.

It answers you on the channels you already use. It can speak and listen on macOS/iOS/Android, and can render a live Canvas you control. The Gateway is just the control plane — the product is the assistant.

If you want a personal, single-user assistant that feels local, fast, and always-on, this is it.

Supported channels include: WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, IRC, Microsoft Teams, Matrix, Feishu, LINE, Mattermost, Nextcloud Talk, Nostr, Synology Chat, Tlon, Twitch, Zalo, Zalo Personal, WeChat, QQ, WebChat.

New install? Start here: [Getting started](https://docs.openclaw.ai/start/getting-started)

Preferred setup: run `openclaw onboard` in your terminal.

OpenClaw Onboard guides you step by step through setting up the gateway, workspace, channels, and skills. It is the recommended CLI setup path and works on **macOS, Linux, and Windows**.

### Install (recommended)

Runtime: **Node 24 (recommended) or Node 22.19+**.

```
bash
npm install -g openclaw@latest
or: pnpm add -g openclaw@latest

openclaw onboard --install-daemon
```

OpenClaw Onboard installs the Gateway daemon (launchd/systemd user service) so it stays running.

## Quick start (TL;DR)

Runtime: **Node 24 (recommended) or Node 22.19+**.

Recommended daemon mode:

```
bash
openclaw onboard --install-daemon
openclaw gateway status
```

Foreground/debug mode:

```
bash
openclaw gateway stop
openclaw gateway --port 18789 --verbose
```

Send a test message or ask the assistant after either startup mode is running:

```
bash
Send a message

openclaw message send --target +1234567890 --message "Hello from OpenClaw"

Talk to the assistant (optionally deliver back to any connected channel: WhatsApp/Telegram/Slack/Discord/Google Chat/Signal/iMessage/IRC/Microsoft Teams/Matrix/Feishu/LINE/Mattermost/Nextcloud Talk/Nostr/Synology Chat/Tlon/Twitch/Zalo/Zalo Personal/WeChat/QQ/WebChat)

openclaw agent --message "Ship checklist" --thinking high
```

Upgrading? [Updating guide](https://docs.openclaw.ai/install/updating) (and run `openclaw doctor`).

### Security defaults (DM access)

OpenClaw connects to real messaging surfaces. Treat inbound DMs as **untrusted input**.

## Highlights

`- Local-first Gateway — single control plane for sessions, channels, tools, and events.
- Multi-channel inbox — WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, IRC, Microsoft Teams, Matrix, Feishu, LINE, Mattermost, Nextcloud Talk, Nostr, Synology Chat, Tlon, Twitch, Zalo, Zalo Personal, WeChat, QQ, WebChat, macOS, iOS/Android.
- Multi-agent routing — route inbound channels/accounts/peers to isolated agents (workspaces + per-agent sessions).
- Voice Wake + Talk Mode — wake words on macOS/iOS and continuous voice on Android (ElevenLabs + system TTS fallback).
- Live Canvas — agent-driven visual workspace with A2UI.
- First-class tools — browser, canvas, nodes, cron, sessions, and Discord/Slack actions.
- Companion apps — Windows Hub, macOS menu bar app, and iOS/Android nodes.
- Onboarding + skills — onboarding-driven setup with bundled/managed/workspace skills.`

## Agent workspace + skills

`- Workspace root: ~/.openclaw/workspace (configurable via agents.defaults.workspace).
- Injected prompt files: AGENTS.md, SOUL.md, TOOLS.md.
- Skills: ~/.openclaw/workspace/skills//SKILL.md.`

### Configuration

`Minimal ~/.openclaw/openclaw.json (model + defaults):`

```
json5
{
  agent: {
    model: "/",
  },
}
```

### Community

`See CONTRIBUTING.md for guidelines, maintainers, and how to submit PRs.
AI/vibe-coded PRs welcome! 🤖`