This project enables users to interact with ChatGPT directly within WeChat, leveraging the wechaty framework and OpenAI's official API. It targets WeChat users who want to integrate AI conversational capabilities into their daily communication. The primary benefit is seamless access to advanced AI models through a familiar messaging interface.

How It Works

The system utilizes the wechaty library to act as a WeChat bot, intercepting messages and forwarding them to the OpenAI API for processing. It supports various deployment methods, including Docker, Docker Compose, and PaaS platforms like Railway and Fly.io, offering flexibility for self-hosting or managed deployments. The architecture allows for customization of ChatGPT models, prompts, and includes features like DALL-E image generation and Whisper speech-to-text.

Quick Start & Requirements

• Primary install/run: Docker (docker run -d --name wechat-chatgpt -e OPENAI_API_KEY=<YOUR_KEY> holegots/wechat-chatgpt:latest) or Docker Compose.
• Prerequisites: Node.js 18.0.0+ for direct Node.js usage. Requires an OpenAI API key. WeChat account must be able to log in via web.
• Deployment: Detailed guides for Railway, Fly.io, Docker, Docker Compose, and Node.js are provided.
• Docs: OpenAI API Key, Custom ChatGPT API.

Highlighted Details

• Supports interaction with ChatGPT, DALL-E, and Whisper.
• Offers flexible deployment options including PaaS (Railway, Fly.io) and self-hosted (Docker).
• Allows configuration of trigger keywords, block words, and custom prompts.
• Includes proxy support (in development).

Maintenance & Community

The project is marked as archived. Contributions are welcome, and a GitHub issues page is available for tracking.

Licensing & Compatibility

The repository does not explicitly state a license in the README. This lack of a specified license may impose restrictions on commercial use or linking with closed-source projects.

Limitations & Caveats

The project has been archived, indicating it may no longer be actively maintained or supported. Compatibility with future WeChat or OpenAI API changes is uncertain.