Skip to content

Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞

License

Notifications You must be signed in to change notification settings

highwayns/openclaw

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15,459 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenClaw — Personal AI Assistant

OpenClaw

EXFOLIATE! EXFOLIATE!

CI status Discord MIT License

OpenClaw is a personal AI assistant you run on your own devices. It answers you on the channels you already use (WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, Microsoft Teams, WebChat), plus extension channels like BlueBubbles, Matrix, Zalo, and Zalo Personal. 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. Website · Docs · Vision · DeepWiki · Getting Started · Updating · Showcase · FAQ · Wizard · Nix · Docker · Discord Preferred setup: run the onboarding wizard (openclaw onboard) in your terminal. The wizard guides you step by step through setting up the gateway, workspace, channels, and skills. The CLI wizard is the recommended path and works on macOS, Linux, and Windows (via WSL2; strongly recommended). Works with npm, pnpm, or bun. New install? Start here: Getting started ## Sponsors | OpenAI | Blacksmith | Convex | | ----------------------------------------------------------------- | ---------------------------------------------------------------------------- | --------------------------------------------------------------------- | | OpenAI | Blacksmith | Convex | Subscriptions (OAuth): - OpenAI (ChatGPT/Codex) Model note: while any model is supported, I strongly recommend Anthropic Pro/Max (100/200) + Opus 4.6 for long‑context strength and better prompt‑injection resistance. See Onboarding. ## Models (selection + auth) - Models config + CLI: Models - Auth profile rotation (OAuth vs API keys) + fallbacks: Model failover ## Install (recommended) Runtime: Node ≥22. bash npm install -g openclaw@latest # or: pnpm add -g openclaw@latest openclaw onboard --install-daemon The wizard installs the Gateway daemon (launchd/systemd user service) so it stays running. ## Quick start (TL;DR) Runtime: Node ≥22. Full beginner guide (auth, pairing, channels): Getting started bash openclaw onboard --install-daemon openclaw gateway --port 18789 --verbose # Send a message openclaw message send --to +1234567890 --message "Hello from OpenClaw" # Talk to the assistant (optionally deliver back to any connected channel: WhatsApp/Telegram/Slack/Discord/Google Chat/Signal/iMessage/BlueBubbles/Microsoft Teams/Matrix/Zalo/Zalo Personal/WebChat) openclaw agent --message "Ship checklist" --thinking high Upgrading? Updating guide (and run openclaw doctor).


Travel business quickstart (highwayns fork)

This fork is used as a travel automation workspace: run OpenClaw locally and install a set of travel-related skills (hotel search/booking, flight search, local service booking, itinerary planning).

⚠️ Safety & compliance

  • Do not auto-purchase or auto-book without explicit user confirmation.
  • Some skills send PII (name/phone/email) to third-party providers to complete bookings.
  • Prefer an approval gate for “create booking / place order” actions.

1) Clone + install from source

Runtime: Node ≥22. Prefer pnpm.

git clone https://github.com/highwayns/openclaw.git
cd openclaw
pnpm install
pnpm ui:build
pnpm build
pnpm openclaw onboard --install-daemon

2) Install travel skills into your workspace

Use the ClawHub CLI (installs into your workspace ./skills/ by default):

npm i -g clawhub
clawhub login

Install the travel skill set (adjust to your needs):

# Itinerary & planning
clawhub install travel
clawhub install travel-planning
clawhub install travel-manager

# Hotels
clawhub install aihotel
clawhub install star-hotel
clawhub install tuniu-hotel
clawhub install booking

# Flights
clawhub install flight-search
clawhub install flight

# Local services (e.g. haircuts, plumbers, etc.)
clawhub install service-booking

# Restaurants/food (region dependent)
clawhub install restaurant-crosscheck-cn
clawhub install swiggy

Verify:

openclaw skills list
openclaw skills check

3) Provider configuration (keys / binaries)

tuniu-hotel (hotel booking via Tuniu MCP) requires an API key:

export TUNIU_API_KEY="YOUR_TUNIU_API_KEY"
# Optional override:
export TUNIU_MCP_URL="https://openapi.tuniu.cn/mcp/hotel"

flight-search may require uvx on your system (check openclaw skills info flight-search).

4) Start the gateway

If you installed the daemon, the gateway may already be running. Check/stop/start:

# Start (will fail if already running on that port)
openclaw gateway --port 18789

# Stop a running gateway
openclaw gateway stop

# Start on the default travel demo port
openclaw gateway --port 18789

5) Run travel queries (CLI)

Some setups require an explicit session id when using the CLI. Use --session-id cli (or your preferred session).

openclaw agent --session-id cli --message "帮我查北京 2026-02-20 入住一晚的酒店,预算 600 元以内,列 5 个"

6) Troubleshooting

A) "Gateway already running" / "Port already in use"

Stop the existing gateway:

openclaw gateway stop
# or, if supervised via systemd user service:
systemctl --user stop openclaw-gateway.service

B) voice-call plugin duplicate id / schema errors (tts Zod schema)

If you see warnings like:

  • duplicate plugin id detected
  • Invalid element at key "tts": expected a Zod schema

You likely have two voice-call plugins configured. Remove/disable your custom plugins.entries.voice-call entry in your config so only the stock plugin remains, then restart the gateway.

Hint: search your config for plugins.entries.voice-call and delete/comment it out:

rg -n "plugins\.entries\.voice-call|voice-call" ~/.openclaw

Then restart:

openclaw gateway stop
openclaw gateway --port 18789

C) openclaw agent says: "Pass --to <E.164>, --session-id, or --agent"

Add a session id (or pick an agent explicitly):

openclaw agent --session-id cli --message "test"
# or:
openclaw agent --agent travel-manager --session-id cli --message "做一个三日东京行程"

Development channels - stable: tagged releases (vYYYY.M.D or vYYYY.M.D-), npm dist-tag latest. - beta: prerelease tags (vYYYY.M.D-beta.N), npm dist-tag beta (macOS app may be missing). - dev: moving head of main, npm dist-tag dev (when published). Switch channels (git + npm): openclaw update --channel stable|beta|dev. Details: Development channels. ## From source (development) Prefer pnpm for builds from source.

Bun is optional for running TypeScript directly. bash git clone https://github.com/openclaw/openclaw.git cd openclaw pnpm install pnpm ui:build # auto-installs UI deps on first run pnpm build pnpm openclaw onboard --install-daemon # Dev loop (auto-reload on TS changes) pnpm gateway:watch Note: pnpm openclaw ... runs TypeScript directly (via tsx). pnpm build produces dist/ for running via Node / the packaged openclaw binary.

Security defaults (DM access) OpenClaw connects to real messaging surfaces. Treat inbound DMs as untrusted input.

Full security guide: Security Default behavior on Telegram/WhatsApp/Signal/iMessage/Microsoft Teams/Discord/Google Chat/Slack: - DM pairing (dmPolicy="pairing" / channels.discord.dmPolicy="pairing" / channels.slack.dmPolicy="pairing"; legacy: channels.discord.dm.policy, channels.slack.dm.policy): unknown senders receive a short pairing code and the bot does not process their message.

  • Approve with: openclaw pairing approve `` (then the sender is added to a local allowlist store). - Public inbound DMs require an explicit opt-in: set dmPolicy="open"and include"*" in the channel allowlist (allowFrom/channels.discord.allowFrom/channels.slack.allowFrom; legacy: channels.discord.dm.allowFrom, channels.slack.dm.policy). Run openclaw doctor` to surface risky/misconfigured DM policies.

Highlights - Local-first Gateway — single control plane for sessions, channels, tools, and events. - Multi-channel inbox — WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, BlueBubbles (iMessage), iMessage (legacy), Microsoft Teams, Matrix, Zalo, Zalo Personal, WebChat, macOS, iOS/Android.

Star History Star History Chart ## Everything we built so far ### Core platform - Gateway WS control plane with sessions, presence, config, cron, webhooks, Control UI, and Canvas host.

Channels - Channels: WhatsApp (Baileys), Telegram (grammY), Slack (Bolt), Discord (discord.js), Google Chat (Chat API), Signal (signal-cli), BlueBubbles (iMessage, recommended), iMessage (legacy imsg), Microsoft Teams (extension), Matrix (extension), Zalo (extension), Zalo Personal (extension), WebChat.

Apps + nodes - macOS app: menu bar control plane, Voice Wake/PTT, Talk Mode overlay, WebChat, debug tools, remote gateway control.


Japan business skill packs (consulting / talent / marketing)

This section lists recommended ClawHub skills for running Japan-focused businesses with OpenClaw. Because the registry changes quickly and quality varies, prefer this workflow:

clawhub inspect <slug>   # review files/scripts/requirements
clawhub install <slug>
openclaw skills info <slug>
openclaw skills check

⚠️ Safety

  • Treat skills as executable code. Do not install untrusted skills.
  • For any “send/publish/purchase/book” action, use an approval gate and explicit confirmation.

A) Enterprise tech consulting & business system development (Japan)

P0 (core delivery / DevOps / cloud-native):

  • devops
  • sw-devops
  • kubernetes
  • terraform-engineer
  • k8s-gen

P1 (platform components / ops):

  • sw-kafka-kubernetes
  • sw-kafka-devops
  • k8s-capi
  • k8s-browser

Install (example):

clawhub install devops
clawhub install sw-devops
clawhub install kubernetes
clawhub install terraform-engineer
clawhub install k8s-gen

Discover tool-chain integrations (pick the ones your client actually uses):

clawhub search jira
clawhub search confluence
clawhub search notion
clawhub search redmine
clawhub search backlog
clawhub search github
clawhub search gitlab
clawhub search aws terraform
clawhub search azure terraform
clawhub search gcp terraform
clawhub search threat model
clawhub search security audit

B) IT talent training & staffing / dispatch (SES / 派遣)

P0 (recruiting + training delivery):

  • resume-cog (ATS-friendly resume building)
  • Meeting notes/action items skill (search below)
  • Course/curriculum/quiz generator skills (search below)
  • Autograder/test runner skills for assignments (search below)

Suggested searches (choose high-quality skills that match your stack):

clawhub search ats resume
clawhub search recruiter pipeline
clawhub search interview questions
clawhub search curriculum course lesson quiz
clawhub search assignment autograde grader
clawhub search meeting minutes action items
clawhub search jira
clawhub search notion

Japan channel note:

  • LINE is typically enabled as a channel plugin (@openclaw/line) rather than a ClawHub skill. Use ClawHub for workflows (follow-ups, templates, summaries).

C) Product marketing (Japan)

P0 (content + distribution + lead nurture):

  • Content/copy/landing/SEO skills (search below)
  • Social scheduling (e.g. mixpost)
  • CRM/email campaign skills (HubSpot/Zoho/Salesforce etc. — choose via search)
  • Competitive monitoring (RSS/brand monitoring)

Suggested searches:

clawhub search content factory
clawhub search copywriting
clawhub search landing page
clawhub search seo
clawhub search mixpost
clawhub search hubspot
clawhub search zoho crm
clawhub search salesforce
clawhub search newsletter email campaign
clawhub search competitor tracking
clawhub search brand monitoring

Japan-specific expansions (pick what you need):

# LINE OA / customer follow-up workflows (channel plugin handles messaging; skills handle workflow)
clawhub search line marketing
clawhub search line oa

# Ecommerce platforms
clawhub search rakuten
clawhub search yahoo shopping
clawhub search amazon seller

# Analytics
clawhub search posthog
clawhub search google analytics
clawhub search mixpanel

About

Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 85.4%
  • Swift 9.9%
  • Kotlin 2.3%
  • Shell 0.8%
  • JavaScript 0.7%
  • CSS 0.4%
  • Other 0.5%