@agent-wechat/wechat 0.1.0 → 0.2.1

package/README.md

@@ -1,47 +1,83 @@
-# OpenClaw WeChat Extension
+# @agent-wechat/wechat
 
 OpenClaw channel plugin for WeChat. Polls the agent-wechat REST API for inbound messages and dispatches replies through OpenClaw's agent runtime.
 
 ## Prerequisites
 
-- A running agent-wechat container (provides the REST API on port 6174)
+- [Docker](https://docs.docker.com/get-docker/) installed and running
 - OpenClaw installed and configured
 
-## Development Setup
+> **Note:** The agent-wechat container requires `SYS_PTRACE` and `seccomp=unconfined` (ptrace access to the WeChat desktop process). It cannot run in serverless or restricted container environments (AWS Fargate, Cloud Run, etc.) — use a VM or bare-metal Docker host.
 
-### 1. Build
+## Setup
 
-From the repo root:
+### 1. Start the agent-wechat container
+
+**Option A: CLI** (quickest for local use)
 
 ```bash
-pnpm install
-pnpm build
+npm install -g @agent-wechat/cli
+wx up
 ```
 
-This builds the shared package, CLI, and bundles the extension into `dist/index.js` via esbuild.
+**Option B: Docker Compose** (production / networked)
+
+```yaml
+services:
+  agent-wechat:
+    image: ghcr.io/thisnick/agent-wechat:latest
+    container_name: agent-wechat
+    security_opt:
+      - seccomp=unconfined
+    cap_add:
+      - SYS_PTRACE
+    ports:
+      - "6174:6174"
+      - "127.0.0.1:5900:5900"
+    volumes:
+      - agent-wechat-data:/data
+      - agent-wechat-home:/home/wechat
+      - ~/.config/agent-wechat/token:/data/auth-token:ro
+    restart: unless-stopped
+
+volumes:
+  agent-wechat-data:
+  agent-wechat-home:
+```
 
-### 2. Deploy to OpenClaw
+Generate a token before starting:
 
 ```bash
-pnpm deploy:openclaw
+mkdir -p ~/.config/agent-wechat
+openssl rand -hex 32 > ~/.config/agent-wechat/token
+chmod 600 ~/.config/agent-wechat/token
+docker compose up -d
 ```
 
-This copies `dist/index.js`, `package.json`, and `openclaw.plugin.json` into `../openclaw/extensions/wechat/` (sibling to the agent-wechat repo). To deploy to a different location:
+If running alongside OpenClaw on the same Docker network, set `serverUrl` to `http://agent-wechat:6174` in the channel config below.
+
+### 2. Install the extension
 
 ```bash
-pnpm deploy:openclaw /path/to/openclaw/extensions/wechat
+openclaw plugins install @agent-wechat/wechat
 ```
 
-### 3. Enable the plugin
+### 3. Log in to WeChat
 
 ```bash
-openclaw plugins enable wechat
+openclaw channels login --channel wechat
 ```
 
+This displays a QR code in your terminal — scan it with WeChat on your phone. You only need to do this once (the session persists across container restarts).
+
+If you installed the CLI, you can also use `wx auth login`.
+
 ### 4. Configure the channel
 
+Run the setup wizard:
+
 ```bash
-openclaw channels add --channel wechat --url http://localhost:6174
+openclaw channels setup wechat
 ```
 
 Or edit `~/.openclaw/openclaw.json` directly:
@@ -53,11 +89,6 @@ Or edit `~/.openclaw/openclaw.json` directly:
       "enabled": true,
       "serverUrl": "http://localhost:6174"
     }
-  },
-  "plugins": {
-    "entries": {
-      "wechat": { "enabled": true }
-    }
   }
 }
 ```
@@ -68,44 +99,7 @@ Or edit `~/.openclaw/openclaw.json` directly:
 openclaw gateway run --verbose
 ```
 
-The WeChat monitor starts polling the agent-wechat server for new messages. Make sure the agent-wechat container is running (`pnpm cli up` / `pnpm cli status`).
-
-### Iterating
-
-After making changes to the extension source:
-
-```bash
-pnpm deploy:openclaw   # rebuilds + copies
-# restart the gateway
-```
-
-## Docker Setup
-
-The extension is bundled into a single `dist/index.js` with no runtime dependency on the shared package. Mount just the three required files:
-
-```bash
-mkdir -p /host/openclaw-ext/wechat/dist
-cp packages/openclaw-extension/dist/index.js    /host/openclaw-ext/wechat/dist/index.js
-cp packages/openclaw-extension/package.json     /host/openclaw-ext/wechat/package.json
-cp packages/openclaw-extension/openclaw.plugin.json /host/openclaw-ext/wechat/openclaw.plugin.json
-
-docker run \
-  -v /host/openclaw-ext/wechat:/app/extensions/wechat \
-  openclaw-image
-```
-
-Inside the container, configure `channels.wechat.serverUrl` to point at the agent-wechat server. If both containers are on the same Docker network:
-
-```json
-{
-  "channels": {
-    "wechat": {
-      "enabled": true,
-      "serverUrl": "http://agent-wechat:6174"
-    }
-  }
-}
-```
+The WeChat monitor starts polling the agent-wechat server for new messages. Make sure the agent-wechat container is running.
 
 ## Configuration Reference
 
@@ -123,6 +117,24 @@ All config lives under `channels.wechat` in OpenClaw's config file:
 | `pollIntervalMs` | integer | `1000` | Message polling interval |
 | `authPollIntervalMs` | integer | `30000` | Auth status check interval |
 
+## Development
+
+### Build from source
+
+```bash
+git clone https://github.com/thisnick/agent-wechat.git
+cd agent-wechat
+pnpm install && pnpm build
+```
+
+### Link for local development
+
+```bash
+openclaw plugins install -l ./packages/openclaw-extension
+```
+
+This symlinks the extension so changes are picked up without reinstalling. Rebuild with `pnpm build` after making changes, then restart the gateway.
+
 ## Architecture
 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agent-wechat/wechat",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "type": "module",
   "files": [
     "dist",