Skip to content

Commit 395007a

Browse files
committed
readme fix
1 parent 98438eb commit 395007a

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

README.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
## What is OpenWhale?
3131

32-
OpenWhale is a **self-extensible AI assistant** that doesn't just chat — it takes action. Connect it to multiple AI models, let it talk on your behalf through WhatsApp/Telegram/Discord/Twitter, browse the web with real browser automation, execute code, manage your calendar, send emails, and basically do whatever you need it to do.
32+
OpenWhale is a **self-extensible AI assistant** that doesn't just chat — it takes action. Connect it to multiple AI models, let it talk on your behalf through WhatsApp/Telegram/Discord/Twitter/iMessage, browse the web with real browser automation, execute code, manage your calendar, send emails, and basically do whatever you need it to do.
3333

3434
Think of it as **Claude, GPT-4, or DeepSeek with arms and legs**.
3535

@@ -66,7 +66,7 @@ Capable of handling long-running, complex tasks with multi-step reasoning. It pl
6666

6767
---
6868

69-
### 💬 4 Messaging Channels
69+
### 💬 5 Messaging Channels
7070
Your AI responds across all platforms — unified inbox, one brain.
7171

7272
| Channel | How it Works |
@@ -75,10 +75,11 @@ Your AI responds across all platforms — unified inbox, one brain.
7575
| **Telegram** | Create a bot with @BotFather |
7676
| **Discord** | Add bot to your server |
7777
| **Twitter/X** | Auto-reply to mentions via bird CLI (cookie auth, no API!) |
78+
| **iMessage** | macOS native — read and send iMessages via `imsg` CLI |
7879

7980
---
8081

81-
### 🛠️ 15 Built-in Tools
82+
### 🛠️ 16 Built-in Tools
8283
The AI can actually DO things, not just talk about them.
8384

8485
| Tool | Capability |
@@ -97,6 +98,7 @@ The AI can actually DO things, not just talk about them.
9798
| **nodes** | Structured data and knowledge graphs |
9899
| **camera** | Take photos/video from connected cameras |
99100
| **location** | Get current geolocation |
101+
| **imessage** | Read and send iMessages on macOS |
100102
| **extend** | Create self-extensions for automated workflows |
101103

102104
<p align="center">
@@ -207,6 +209,7 @@ Production-ready security out of the box.
207209
| **Run shell commands** | ✅ Full access | ❌ No | ❌ No | ❌ No |
208210
| **Browser automation** | ✅ Playwright + BrowserOS | ❌ Limited | ✅ Limited | ❌ No |
209211
| **WhatsApp/Telegram/Discord** | ✅ All channels | ❌ No | ❌ No | ❌ Maybe one |
212+
| **iMessage (macOS)** | ✅ Native | ❌ No | ❌ No | ❌ No |
210213
| **Twitter integration** | ✅ Full API | ❌ No | ❌ No | ❌ No |
211214
| **Self-extensible** | ✅ Creates own tools | ❌ No | ❌ No | ❌ No |
212215
| **Runs locally** | ✅ Your machine | ❌ Cloud only | ❌ Cloud only | ❌ Usually cloud |
@@ -325,7 +328,7 @@ OpenWhale comes with a web dashboard for managing everything without touching th
325328
### What you can do from the dashboard:
326329

327330
- **Chat** — Talk to the AI with full tool support
328-
- **Connect channels** — Link WhatsApp, Telegram, Discord by scanning QR codes or adding tokens
331+
- **Connect channels** — Link WhatsApp, Telegram, Discord, iMessage by scanning QR codes or adding tokens
329332
- **Manage providers** — Add API keys for Claude, GPT-4, Gemini, etc.
330333
- **Configure skills** — Enable GitHub, Notion, Weather, Google services
331334
- **View message history** — See all conversations across channels
@@ -438,6 +441,41 @@ brew install steipete/tap/bird
438441

439442
> ⚠️ **Note:** Twitter/X may rate-limit or flag automated posting. Use with caution on accounts you care about.
440443
444+
### iMessage (macOS only)
445+
446+
OpenWhale can read and send iMessages natively on macOS using the `imsg` CLI.
447+
448+
**Prerequisites:**
449+
- macOS (iMessage is not available on other platforms)
450+
- Messages.app signed in with your Apple ID
451+
- Full Disk Access granted to your terminal (System Settings → Privacy & Security → Full Disk Access)
452+
- Automation permission for Messages.app
453+
454+
**Install imsg CLI:**
455+
```bash
456+
brew install steipete/tap/imsg
457+
```
458+
459+
**Via Dashboard:**
460+
1. Go to `http://localhost:18789/dashboard`
461+
2. Navigate to **Channels**
462+
3. Find the **iMessage** card
463+
4. Click **⬇️ Install imsg CLI** (if not already installed)
464+
5. Click **📱 Connect iMessage**
465+
6. Done! The AI can now read and send iMessages
466+
467+
**What the AI can do with iMessage:**
468+
- **List chats** — See your recent iMessage conversations
469+
- **Read messages** — Read message history from any chat
470+
- **Send messages** — Send iMessages to any phone number or email
471+
472+
**Example prompts:**
473+
- *"Show me my recent iMessage conversations"*
474+
- *"Read my latest messages from Mom"*
475+
- *"Send an iMessage to +1234567890 saying I'll be there in 10 minutes"*
476+
477+
> ⚠️ **Note:** iMessage requires macOS. On other platforms, the iMessage card will show as unavailable. The connection persists across server restarts.
478+
441479
---
442480

443481
## Tools
@@ -460,6 +498,7 @@ These are the built-in capabilities the AI can use. You don't need to configure
460498
| **nodes** | Work with structured data and knowledge graphs |
461499
| **camera** | Take photos or record video from connected cameras |
462500
| **location** | Get current geolocation data |
501+
| **imessage** | Read and send iMessages on macOS via `imsg` CLI |
463502
| **extend** | Create self-extensions for automated workflows |
464503

465504
---

0 commit comments

Comments
 (0)