wechat-clawdbot

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #golang #machine-learning #rust #linux #nodejs #windows #cli #awesome-list #vue #ios

wechat-clawdbot

(★ 10)

Bridge WeChat to Clawdbot AI Gateway

wechat-clawdbot Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🤖 WeChat Clawdbot Bridge

**Connect WeChat to AI-powered conversations via Clawdbot Gateway**

[![Node.js](https://img.shields.io/badge/Node.js-22+-339933?style=flat-square&logo=node.js&logoColor=white)](https://nodejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.6+-3178C6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
[![Platform](https://img.shields.io/badge/Platform-Windows-0078D6?style=flat-square&logo=windows&logoColor=white)](https://www.microsoft.com/windows)
[![License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://raw.githubusercontent.com/zhulenghan/wechat-clawdbot/master/LICENSE)

[Features](#-features) • [Quick Start](#-quick-start) • [Configuration](#%EF%B8%8F-configuration) • [Architecture](#-architecture)

</div>

---

## ✨ Features

- 🔗 **Seamless Integration** - Bridge WeChat messages to Clawdbot's powerful AI agents
- 💬 **Group & DM Support** - Handle both private and group conversations
- 🛡️ **Rate Limiting** - Built-in anti-ban protection with configurable limits
- 🎯 **Smart Triggers** - Respond to @mentions and custom keywords in groups
- 🔄 **Session Continuity** - Maintain conversation context across messages
- 📝 **Structured Logging** - Beautiful JSON logs powered by Pino

## 📋 Prerequisites

- **Windows PC** with WeChat installed
- **WeChat version 3.9.12.17** (required for WeChatFerry compatibility)
- **Node.js 22+**
- **Clawdbot Gateway** running locally

## 🛡️ Recommended: Use Windows Sandbox

For security and isolation, we **strongly recommend** running WeChat inside [Windows Sandbox](https://learn.microsoft.com/en-us/windows/security/application-security/application-isolation/windows-sandbox/windows-sandbox-overview).

### Why Windows Sandbox?

- 🔒 **Isolation** - WeChat runs in a completely isolated environment
- 🧹 **Clean State** - Each session starts fresh, no persistent data leakage
- 🛡️ **Security** - Protects your main system from potential risks
- 🔄 **Easy Reset** - Simply close and reopen for a clean environment

### Enable Windows Sandbox

1. Open **Settings** → **Apps** → **Optional Features** → **More Windows Features**
2. Check **Windows Sandbox** and click OK
3. Restart your computer

### Sandbox Configuration

Create a `.wsb` file to auto-configure your sandbox:

```xml
<Configuration>
  <MappedFolders>
    <MappedFolder>
      <HostFolder>C:\path\to\wechat-clawdbot</HostFolder>
      <SandboxFolder>C:\wechat-clawdbot</SandboxFolder>
      <ReadOnly>false</ReadOnly>
    </MappedFolder>
  </MappedFolders>
  <MemoryInMB>4096</MemoryInMB>
  <Networking>Default</Networking>
</Configuration>
```

Then install WeChat 3.9.12.17 and Node.js inside the sandbox.

## 🚀 Quick Start

### 1. Install Dependencies

```bash
npm install
```

### 2. Configure Environment

```bash
cp .env.example .env
```

Edit `.env` with your settings:

```env
CLAWDBOT_GATEWAY_URL=ws://127.0.0.1:18789
CLAWDBOT_GATEWAY_TOKEN=your-secret-token
```

### 3. Install and Setup Clawdbot

```bash
# Install Clawdbot globally
npm install -g clawdbot

# Run the onboarding wizard (first time only)
clawdbot onboard
```

The onboarding wizard will guide you through:
- Setting up your AI provider (Google Gemini, OpenAI, etc.)
- Configuring authentication
- Initial gateway settings

### 4. Configure Clawdbot HTTP API

Add HTTP API support to your Clawdbot config (`~/.clawdbot/config.json`):

```json
{
  "gateway": {
    "http": {
      "endpoints": {
        "chatCompletions": { "enabled": true }
      }
    }
  }
}
```

### 5. Start Clawdbot Gateway

```bash
clawdbot gateway --port 18789
```

### 6. Run the Bridge

```bash
# Development (with hot reload)
npm run dev

# Production
npm run build && npm start
```

## ⚙️ Configuration

| Variable | Description | Default |
|----------|-------------|---------|
| `CLAWDBOT_GATEWAY_URL` | Gateway WebSocket URL | `ws://127.0.0.1:18789` |
| `CLAWDBOT_GATEWAY_TOKEN` | Authentication token | - |
| `MESSAGE_INTERVAL_MS` | Delay between messages (ms) | `5000` |
| `MAX_DAILY_MESSAGES` | Daily message limit | `200` |
| `GROUP_ENABLED` | Enable group chat support | `true` |
| `GROUP_TRIGGER_ON_AT` | Respond to @mentions | `true` |
| `GROUP_TRIGGER_KEYWORDS` | Trigger keywords (comma-separated) | - |
| `LOG_LEVEL` | Logging level | `info` |

## 🏗 Architecture

```
┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│                 │     │                  │     │                 │
│   WeChat PC     │◄───►│  WeChatFerry     │◄───►│   This Bridge   │
│   (3.9.12.17)   │     │  Agent           │     │                 │
│                 │     │                  │     │                 │
└─────────────────┘     └──────────────────┘     └────────┬────────┘
                                                          │
                                                          │ HTTP API
                                                          │ /v1/chat/completions
                                                          ▼
                                                ┌─────────────────┐
                                                │                 │
                                                │    Clawdbot     │
                                                │    Gateway      │
                                                │                 │
                                                └────────┬────────┘
                                                         │
                                                         ▼
                                                ┌─────────────────┐
                                                │   AI Model      │
                                                │ (Gemini, etc.)  │
                                                └─────────────────┘
```

### Message Flow

1. **Incoming**: WeChat → WeChatFerry → Bridge → Clawdbot HTTP API → AI Response
2. **Outgoing**: AI Response → Bridge → WeChatFerry → WeChat

## 📁 Project Structure

```
src/
├── index.ts              # Main entry point
├── config.ts             # Environment configuration
├── clawdbot/
│   ├── gateway.ts        # Clawdbot HTTP API client
│   └── types.ts          # Type definitions
├── bridge/
│   ├── adapter.ts        # Message context adapter
│   ├── queue.ts          # Rate-limited message queue
│   └── session.ts        # Session management
├── wechat/
│   └── types.ts          # WeChat message types
└── utils/
    ├── logger.ts         # Pino logger setup
    └── retry.ts          # Utility functions
```

## 🔧 Development

```bash
# Run with hot reload
npm run dev

# Type checking
npm run typecheck

# Build for production
npm run build
```

## ⚠️ Important Notes

- **WeChat Version**: Must use exactly version **3.9.12.17** - WeChatFerry relies on fixed memory addresses
- **Windows Only**: WeChatFerry only works on Windows with WeChat PC
- **Account Safety**: Use reasonable rate limits to avoid account restrictions
- **Sandbox Recommended**: Run WeChat in Windows Sandbox for better security

## 📄 License

---

**Built with ❤️ for the WeChat + AI community**

</div>

wechat-clawdbot

wechat-clawdbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

wechat-clawdbot

wechat-clawdbot Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README