wechat-chatgpt

<div align="center"> <h1 style="color:red; font-size:48px;">!!!! 项目已归档 📦 !!!!</h1>

本项目已归档。感谢所有贡献者！🙌😔

</div> <h1 align="center">欢迎使用 wechat-chatgpt 👋</h1> <p> <img alt="版本" src="https://yellow-cdn.veclightyear.com/835a84d5/ffd5752e-7840-4d4b-89d7-9ef92146e144.svg?cacheSeconds=2592000" /> <a href="#" target="_blank"> <img alt="许可证：ISC" src="https://yellow-cdn.veclightyear.com/835a84d5/b3d94805-9503-4347-8b8a-533fd5c3bebf.svg" /> </a> <a href="https://twitter.com/fuergaosi" target="_blank"> <img alt="Twitter: fuergaosi" src="https://yellow-cdn.veclightyear.com/835a84d5/3046904f-a21f-47fe-acee-b8a740e8338e.svg?style=social" /> </a> </a> <a href="https://discord.gg/8fXNrxwUJH" target="blank"> <img src="https://img.shields.io/discord/1058994816446369832?label=加入社区&logo=discord&style=flat-square" alt="加入 github profile readme generator 的 discord 社区"/> </a> </p>

通过 wechaty 在微信上使用 ChatGPT
English | 中文文档

🌟 特性

• 与微信和 ChatGPT 交互：

  • 使用 wechaty 和 官方 API 在微信上使用 ChatGPT
  • 添加对话支持
  • 支持命令设置

• 部署和配置选项：

  • 添加 Dockerfile，可用 docker 部署
  • 支持使用 docker compose 部署
  • 支持 Railway 和 Fly.io 部署

• 其他功能：

  • 支持 Dall·E
  • 支持 whisper
  • 支持设置提示词
  • 支持代理（开发中）

🚀 使用方法

• 使用 Railway（PaaS，免费，稳定，✅推荐）
• 使用 Fly.io（PaaS，免费，✅推荐）
• 使用 docker（自托管，稳定，✅推荐）
• 使用 docker compose（自托管，稳定，✅推荐）
• 使用 nodejs（自托管）

使用 Railway

Railway 每月提供 $5 或 500 小时的运行时间

1. 点击 Railway 按钮进入 Railway 部署页面
2. 点击 Deploy Now 按钮进入 Railway 部署页面
3. 填写仓库名称和 OPENAI_API_KEY（需要链接 GitHub 帐号）
4. 点击 Deploy 按钮
5. 点击 View Logs 按钮并等待部署完成

使用 Fly.io

请为应用程序分配 512MB 内存以满足应用要求

fly.io 提供最高 $5 的免费账单（免费配额中的 3 个 256MB 实例不计入账单）

1. 安装 flyctl

    # macOS
    brew install flyctl
    # Windows
    scoop install flyctl
    # Linux
    curl https://fly.io/install.sh | sh

2. 克隆项目并进入项目目录

   git clone https://github.com/fuergaosi233/wechat-chatgpt.git && cd wechat-chatgpt

3. 创建新应用

   ➜ flyctl launch 
    ? 是否要复制其配置到新应用？否
    ? 应用名称（留空使用自动生成的名称）：<你的应用名称>
    ? 选择区域：<你选择的区域>
    ? 是否现在设置 Postgresql 数据库？否
    ? 是否现在部署？否

4. 配置环境变量

   flyctl secrets set OPENAI_API_KEY="<你的 OPENAI API KEY>" MODEL="<CHATGPT-模型>"

5. 部署应用

   flyctl deploy

使用 docker

# 拉取镜像
docker pull holegots/wechat-chatgpt
# 运行容器
docker run -d --name wechat-chatgpt \
    -e OPENAI_API_KEY=<你的 OPENAI API KEY> \
    -e MODEL="gpt-3.5-turbo" \
    -e CHAT_PRIVATE_TRIGGER_KEYWORD="" \
    -v $(pwd)/data:/app/data/wechat-assistant.memory-card.json \
    holegots/wechat-chatgpt:latest
# 查看二维码登录微信
docker logs -f wechat-chatgpt

如何获取 OPENAI API KEY？点击这里

使用 docker compose

# 根据模板复制配置文件
cp .env.example .env
# 编辑配置文件
vim .env
# 启动容器
docker-compose up -d
# 查看二维码登录微信
docker logs -f wechat-chatgpt

使用 nodejs

你需要 NodeJS 18.0.0 及以上版本

# 克隆项目
git clone https://github.com/fuergaosi233/wechat-chatgpt.git && cd wechat-chatgpt
# 安装依赖
npm install
# 根据模板复制配置文件
cp .env.example .env
# 编辑配置文件
vim .env
# 启动项目
npm run dev

请确保你的微信账号可以登录 网页版微信

📝 环境变量

名称	描述
API	ChatGPT 的 API 端点
OPENAI_API_KEY	创建新的密钥
MODEL	要使用的模型 ID。目前仅支持 gpt-3.5-turbo 和 gpt-3.5-turbo-0301。
TEMPERATURE	使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较低的值（如 0.2）将使输出更加集中和确定。
CHAT_TRIGGER_RULE	私聊触发规则。
DISABLE_GROUP_MESSAGE	禁止在群聊中使用 ChatGPT。
CHAT_PRIVATE_TRIGGER_KEYWORD	在微信私聊中触发 ChatGPT 回复的关键词
BLOCK_WORDS	聊天屏蔽词（适用于私聊和群聊，使用逗号分隔）
CHATGPT_BLOCK_WORDS	ChatGPT 返回的屏蔽词（适用于私聊和群聊，使用逗号分隔）

📝 使用自定义 ChatGPT API

https://github.com/fuergaosi233/openai-proxy

# 克隆项目
git clone https://github.com/fuergaosi233/openai-proxy
# 安装依赖
npm install && npm install -g wrangler && npm run build
# 部署到 CloudFlare Workers
npm run deploy
# 自定义域名（可选）
在 `wrangler.toml` 中添加 `Route`
routes = [
    { pattern = "你的自定义域名", custom_domain = true },
]

⌨️ 命令

在微信聊天框中输入

/cmd help # 显示帮助
/cmd prompt <提示词> # 设置提示词
/cmd clear # 清除上次启动以来的所有会话

✨ 贡献者

<a href="https://github.com/fuergaosi233/wechat-chatgpt/graphs/contributors"> <img src="https://contrib.rocks/image?repo=fuergaosi233/wechat-chatgpt" /> </a>

🤝 贡献

欢迎贡献、提issues和功能需求！<br />随时查看 issues 页面。

表示支持

如果这个项目对你有帮助，请给一个 ⭐️！