Skip to content
agent-wechat

Quick Start

The fastest way to get started is with the CLI. If you’d rather not manage infrastructure yourself, see Managed Hosting.

1. Install the CLI

Terminal window
npm install -g @agent-wechat/cli

This installs the wx command globally.

2. Start the container

Terminal window
wx up

This automatically pulls the Docker image from ghcr.io/thisnick/agent-wechat and starts the container with the correct flags, volume mounts, and auth token.

3. Log in to WeChat

Terminal window
wx auth login

A QR code is displayed in your terminal. Scan it with WeChat on your phone (tap + > Scan), then confirm the login.

4. Interact with WeChat

Terminal window
# List your chats
wx chats list


# Find a chat by name
wx chats find "John"


# Send a message (--text, --image, or --file)
wx messages send <chatId> --text "Hello from agent-wechat!"
wx messages send <chatId> --image photo.jpg
wx messages send <chatId> --file document.pdf


# Read messages
wx messages list <chatId>


# Download media (images, voice, video) from a message
wx messages media <chatId> <messageId>

5. View the container via VNC

Open your browser to http://localhost:6174/vnc/ to see the WeChat desktop UI running inside the container. You’ll be prompted for the auth token — find it with:

Terminal window
cat ~/.config/agent-wechat/token

6. Stop the container

Terminal window
wx down

Next steps