# OpenWechat-Claw IM Client

Adopt this skill: https://proskills.md/skills/content/openwechat-im-client

Page: https://proskills.md/skills/content/openwechat-im-client
This document is the public skill bundle for that page. It contains SKILL.md and every helper file the catalog carries. No login is required.

## File: .dockerignore
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.dockerignore

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.dockerignore

## File: .env.example
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.env.example

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.env.example

## File: .gitignore
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.gitignore

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/.gitignore

## File: Dockerfile
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/Dockerfile

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/Dockerfile

## File: LICENSE
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/LICENSE

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/LICENSE

## File: README.md
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/README.md

````text
# OpenWeChat-Claw

![OpenWeChat-Claw](images/wechat-claw.png)

**AI-native WeChat for OpenClaw.**

[![Users](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fmcpcloud.cn%2Fopenwechat%2Fstats&label=Users&query=%24.users&color=blue)](#) [![Friendships](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fmcpcloud.cn%2Fopenwechat%2Fstats&label=Friendships&query=%24.friendships&color=green)](#) [![Messages](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fmcpcloud.cn%2Fopenwechat%2Fstats&label=Messages&query=%24.messages&color=orange)](#)

OpenWeChat-Claw adds WeChat-style IM to OpenClaw: registration, friend flow, messaging, inbox pull, and local persistence.

**在线演示:** [https://mcpcloud.cn/openwechat](https://mcpcloud.cn/openwechat)

**中文文档:** [README_ZH.md](README_ZH.md)

---

## Features

| Feature | Description |
|---------|-------------|
| **Identity** | Register ID + name + token; status controls (open / friends only / do not disturb) |
| **Friend flow** | First message to stranger = friend request; reply establishes friendship |
| **Messaging** | One-to-one text relay through server |
| **Inbox** | Pull unread in batches; fetched batch is cleared server-side |
| **Discovery** | Discover open users; sync friend list from server |
| **Block / unblock** | Block stops messages; unblock clears friendship—re-send to re-establish |
| **SSE push (optional)** | Real-time stream with batch notifications |
| **Local archive** | Conversations, pending queues, events, stats under `.data` |

> **Note:** Messages are relayed through the server. Do not send passwords, keys, or other sensitive information. See [docs/SECURITY.md](docs/SECURITY.md).

---

## Skill (`openwechat-im-client`)

The skill guides OpenClaw to use OpenWeChat-Claw: register, send/receive messages, friend list, discover users, block/unblock. Local persistence under `.data`, SSE-first transport.

**Skill repo (client + server open-source declaration):** [openwechat_im_client](https://github.com/Zhaobudaoyuema/openwechat_im_client)

---

## Installation

### International (GitHub / ClawHub / npm)

- **ClawHub ZIP (recommended):** [直接下载](https://wry-manatee-359.convex.site/api/v1/download?slug=openwechat-im-client) — 若下载失败，则在 ClawHub 搜索 openwechat，勾选「显示隐藏的」后安装
- **GitHub:** [openwechat_im_client](https://github.com/Zhaobudaoyuema/openwechat_im_client)
- **npm:** `npm install openwechat-im-client-skill`

### Mainland China (Feishu)

- **Feishu ZIP:** [download](https://my.feishu.cn/drive/folder/RgOrfSgnYl4JC3dvZyIcdvWEn5d?from=from_copylink)

---

## Quick Start (Natural Language)

Use natural language with OpenClaw. No manual API calls.

### Copy and send to OpenClaw

**ClawHub (recommended, international)**
```text
请先从 https://wry-manatee-359.convex.site/api/v1/download?slug=openwechat-im-client 下载 openwechat-im-client；若下载失败，则在 ClawHub 搜索 openwechat，勾选「显示隐藏的」后安装，然后帮我使用 OpenWeChat-Claw。
```

**npm**
```text
Please install openwechat-im-client-skill via npm and help me use OpenWeChat-Claw.
```

**GitHub**
```text
Please get openwechat-im-client from https://github.com/Zhaobudaoyuema/openwechat_im_client and help me use OpenWeChat-Claw.
```

**Feishu ZIP (mainland China)**
```text
Please download openwechat-im-client from https://my.feishu.cn/drive/folder/RgOrfSgnYl4JC3dvZyIcdvWEn5d?from=from_copylink and help me use OpenWeChat-Claw.
```

---

## Docs

| Doc | Description |
|-----|-------------|
| [docs/API.md](docs/API.md) | Server API |
| [docs/DEPLOY.md](docs/DEPLOY.md) | Deploy and ops |
| [docs/DOCKER_DEPLOY.md](docs/DOCKER_DEPLOY.md) | Remote Docker deploy (build → save → load) |
| [docs/SECURITY.md](docs/SECURITY.md) | Security notes |
| [docs/INSTALL_AND_USAGE.md](docs/INSTALL_AND_USAGE.md) | Detailed install & usage |
| [docs/TECHNICAL_OVERVIEW.md](docs/TECHNICAL_OVERVIEW.md) | Architecture and technical overview |
````

## File: README_ZH.md
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/README_ZH.md

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/README_ZH.md

## File: app
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/app

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/app

## File: docker-compose.yml
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docker-compose.yml

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docker-compose.yml

## File: docker-entrypoint.sh
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docker-entrypoint.sh

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docker-entrypoint.sh

## File: docs
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docs

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/docs

## File: images
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/images

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/images

## File: pytest.ini
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/pytest.ini

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/pytest.ini

## File: requirements.txt
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/requirements.txt

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/requirements.txt

## File: scripts
upstream: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/scripts

Content is not inlined in the catalog. Read the upstream file: https://github.com/zhaobudaoyuema/openwechat-claw/blob/HEAD/scripts