diff --git a/README.md b/README.md index 86c34aeab..cf145e111 100644 --- a/README.md +++ b/README.md @@ -199,11 +199,15 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): ### WhatsApp +[Read the WhatsApp provider guide in docs/whatsapp.md.](docs/whatsapp.md) + - Link the device: `pnpm clawdbot login` (stores creds in `~/.clawdbot/credentials`). - Allowlist who can talk to the assistant via `whatsapp.allowFrom`. ### Telegram +[Read the Telegram provider guide in docs/telegram.md.](docs/telegram.md) + - Set `TELEGRAM_BOT_TOKEN` or `telegram.botToken` (env wins). - Optional: set `telegram.groups` (with `telegram.groups."*".requireMention`), `telegram.allowFrom`, or `telegram.webhookUrl` as needed. @@ -215,8 +219,16 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): } ``` +### Slack + +[Read the Slack provider guide in docs/slack.md.](docs/slack.md) + +- Set `SLACK_BOT_TOKEN` + `SLACK_APP_TOKEN` (or `slack.botToken` + `slack.appToken`). + ### Discord +[Read the Discord provider guide in docs/discord.md.](docs/discord.md) + - Set `DISCORD_BOT_TOKEN` or `discord.token` (env wins). - Optional: set `discord.slashCommand`, `discord.dm.allowFrom`, `discord.guilds`, or `discord.mediaMaxMb` as needed. @@ -228,6 +240,24 @@ Minimal `~/.clawdbot/clawdbot.json` (model + defaults): } ``` +### Signal + +[Read the Signal provider guide in docs/signal.md.](docs/signal.md) + +- Requires `signal-cli` and a `signal` config section. + +### iMessage + +[Read the iMessage provider guide in docs/imessage.md.](docs/imessage.md) + +- macOS only; Messages must be signed in. + +### WebChat + +[Read the WebChat guide in docs/webchat.md.](docs/webchat.md) + +- Uses the Gateway WebSocket; no separate WebChat port/config. + Browser control (optional): ```json5 @@ -242,21 +272,25 @@ Browser control (optional): ## Docs -[Start with the docs index for navigation and “what’s where.”](https://docs.clawdbot.com/) -[Read the architecture overview for the gateway + protocol model.](https://docs.clawdbot.com/architecture) -[Use the full configuration reference when you need every key and example.](https://docs.clawdbot.com/configuration) -[Run the Gateway by the book with the operational runbook.](https://docs.clawdbot.com/gateway) -[Learn how the Control UI/Web surfaces work and how to expose them safely.](https://docs.clawdbot.com/web) -[Understand remote access over SSH tunnels or tailnets.](https://docs.clawdbot.com/remote) -[Follow the onboarding wizard flow for a guided setup.](https://docs.clawdbot.com/wizard) -[Wire external triggers via the webhook surface.](https://docs.clawdbot.com/webhook) -[Set up Gmail Pub/Sub triggers.](https://docs.clawdbot.com/gmail-pubsub) -[Learn the macOS menu bar companion details.](https://clawdbot.com/clawdbot-mac.html) -[Debug common failures with the troubleshooting guide.](https://docs.clawdbot.com/troubleshooting) -[Review security guidance before exposing anything.](https://docs.clawdbot.com/security) +- [Start with the docs index for navigation and “what’s where.”](https://docs.clawdbot.com/) +- [Read the architecture overview for the gateway + protocol model.](https://docs.clawdbot.com/architecture) +- [Use the full configuration reference when you need every key and example.](https://docs.clawdbot.com/configuration) +- [Run the Gateway by the book with the operational runbook.](https://docs.clawdbot.com/gateway) +- [Learn how the Control UI/Web surfaces work and how to expose them safely.](https://docs.clawdbot.com/web) +- [Understand remote access over SSH tunnels or tailnets.](https://docs.clawdbot.com/remote) +- [Follow the onboarding wizard flow for a guided setup.](https://docs.clawdbot.com/wizard) +- [Wire external triggers via the webhook surface.](https://docs.clawdbot.com/webhook) +- [Set up Gmail Pub/Sub triggers.](https://docs.clawdbot.com/gmail-pubsub) +- [Learn the macOS menu bar companion details.](https://clawdbot.com/clawdbot-mac.html) +- [Debug common failures with the troubleshooting guide.](https://docs.clawdbot.com/troubleshooting) +- [Review security guidance before exposing anything.](https://docs.clawdbot.com/security) ## Email hooks (Gmail) +[Gmail Pub/Sub wiring (gcloud + gogcli), hook tokens, and auto-watch behavior are documented here.](https://docs.clawdbot.com/gmail-pubsub) + +Gateway auto-starts the watcher when `hooks.enabled=true` and `hooks.gmail.account` is set; `clawdbot hooks gmail run` is the manual daemon wrapper if you don’t want auto-start. + ```bash clawdbot hooks gmail setup --account you@gmail.com clawdbot hooks gmail run @@ -270,8 +304,20 @@ AI/vibe-coded PRs welcome! 🤖 ## Clawd -Clawdbot was built for **Clawd**, a space lobster AI assistant. 🦞 +Clawdbot was built for **Clawd**, a space lobster AI assistant. 🦞 +by Peter Steinberger and the community. - https://clawd.me - https://soul.md - https://steipete.me + +## Community + +Thanks to everyone who has contributed: + +