|
+| --- | --- |
+
+### 运行报错等问题
+
+首先你需要做到以下几点：
+
+- 拉取最新代码，重新安装依赖（删除 lock 文件，删除 node_modules）
+- 安装依赖时最好不要设置 npm 镜像
+- 遇到 puppeteer 安装失败设置环境变量：
+
+ ```
+ # Mac
+ export PUPPETEER_SKIP_DOWNLOAD='true'
+
+ # Windows
+ SET PUPPETEER_SKIP_DOWNLOAD='true'
+ ```
+
+- 如果使用云端模型，确保终端网络可以访问对应模型服务（开全局代理，或者手动设置终端代理）
+
+ ```sh
+ # 设置代理
+ export https_proxy=http://127.0.0.1:你的代理服务端口号;export http_proxy=http://127.0.0.1:你的代理服务端口号;export all_proxy=socks5://127.0.0.1:你的代理服务端口号
+ # 然后执行对应服务测试，或先查看 CLI 是否正常
+ node ./cli.js --help
+ ```
+
+ 
+
+- 如果使用 OpenAI / Claude / Kimi 等云端模型，确认 API Key、余额、模型名和代理配置正确
+- 配置好 `.env` 文件，尤其是 `BOT_NAME`、白名单和当前 `--serve` 服务所需参数
+- 执行 `npm run test:analysis` 验证本地分析模块，执行 `node ./cli.js --help` 验证 CLI
+- 执行 `wb agent --im wechat --agent pi` 或 `wb start --serve <服务名>` 启动微信扫码
+
+也可以参考这条 [issue](https://github.com/wangrongding/wechat-bot/issues/54#issuecomment-1347880291)
+
+- 怎么玩？ 完成自定义修改后，群聊时，在白名单中的群，有人 @你 时会触发自动回复，私聊中，联系人白名单中的人发消息给你时会触发自动回复。
+- 运行报错？检查 node 版本是否符合，如果不符合，升级 node 版本即可，检查依赖是否安装完整，如果不完整，大陆推荐切换下 npm 镜像源，然后重新安装依赖即可。（可以用我的 [prm-cli](https://github.com/wangrongding/prm-cli) 工具快速切换）
+- 调整对话模式？优先通过 `--serve` 切换服务；需要定制业务逻辑时看 [sendMessage.js](./src/wechaty/sendMessage.js)、[commandRouter.js](./src/platforms/wechat/commandRouter.js) 和对应 provider 实现。
+
+## 使用 Docker 部署
+
+```sh
+$ docker build . -t wechat-bot
+
+$ docker run -d --rm --name wechat-bot -v $(pwd)/.env:/app/.env wechat-bot
+```
+
+- 如果docker build过程中node反复下载超时，可先下载nodejs镜像到本地镜像库，并将DockerFile中的'node:19'修改为本地nodejs镜像版本
+
+## Star History Chart
+
+该项目于 2023/2/13 日成为 Github Trending 榜首。
+
+[](https://star-history.com/#wangrongding/wechat-bot&Date)
+
+## License
+
+[MIT](./LICENSE).
diff --git a/RECORD.md b/RECORD.md
new file mode 100644
index 0000000..738d58d
--- /dev/null
+++ b/RECORD.md
@@ -0,0 +1,30 @@
+# 使用最近很火的 OpenAi ChatGPT 配合 Wechaty 实现一个 微信聊天機器人
+
+## 前言
+
+使用 OpenAi ChatGPT 和 Wechaty 可以实现一个微信聊天机器人。OpenAi ChatGPT 是一个大型语言模型，能够模拟人类聊天对话，并回答用户的问题。Wechaty 是一个 Node.js 库，可以让开发者轻松地接入微信并实现聊天机器人功能。
+
+首先，需要安装 Node.js 和 npm（Node.js 包管理器）。安装完成后，使用 npm 安装 Wechaty 和 OpenAi ChatGPT。
+
+## 什么是 OpenAi ChatGPT
+
+OpenAI ChatGPT 是一个语言模型，由 OpenAI 开发。它是基于 GPT-3（Generative Pretrained Transformer-3）架构的，用于对话和聊天的自然语言处理（NLP）任务。它的目的是通过模仿人类的语言方式来生成文本。
+
+与其他语言模型不同，OpenAI ChatGPT 可以记忆之前的对话内容，并根据上下文和预先学习的知识来生成自然的回复。它可以用于支持机器人，聊天机器人和其他应用程序，以提供更加人性化和自然的对话体验。
+
+OpenAI ChatGPT 模型使用了大量的语料数据进行预训练，并通过机器学习算法来优化其生成文本的能力。它具有出色的自然语言理解能力，可以模拟人类的语言特征，如句子结构、语法和修辞手法。
+
+总的来说，OpenAI ChatGPT 是一个非常强大的语言模型，可以用于实现多种 NLP 应用程序，以提高对话和聊天的自然语言处理能力。
+
+## 什么是 Wechaty
+
+## 一些相关链接
+
+- [OpenAI ChatGPT](https://openai.com/blog/chatting/)
+- [Wechaty](https://wechaty.js.org/)
+- [Wechaty Chatbot](https://wechaty.js.org/docs/examples/chatbot/)
+- [Wechaty Chatbot Tutorial](https://wechaty.js.org/docs/tutorials/chatbot-tutorial/)
+
+- https://openai.com/blog/chatgpt/
+- https://download-chromium.appspot.com/?platform=Mac_Arm&type=snapshots
+- https://registry.npmmirror.com/binary.html?path=chromium-browser-snapshots/Mac_Arm/
diff --git a/cli.js b/cli.js
new file mode 100644
index 0000000..f1bf3f8
--- /dev/null
+++ b/cli.js
@@ -0,0 +1,4 @@
+#! /usr/bin/env node
+
+'use strict'
+import('./src/index.js')
diff --git a/docs/pi-im-agent.md b/docs/pi-im-agent.md
new file mode 100644
index 0000000..797ba9a
--- /dev/null
+++ b/docs/pi-im-agent.md
@@ -0,0 +1,219 @@
+# Pi Agent + IM 使用说明
+
+这份文档说明如何把当前项目作为 Pi agent 的运行壳，用 IM 作为外部通信渠道。
+
+## 目标链路
+
+```text
+外部 IM 消息 -> wechat-bot -> Pi agent -> IM 回复
+```
+
+当前已实现：
+
+- 微信 IM：扫码登录后接收/回复消息。
+- Pi agent：作为 `serve` 类型处理微信消息。
+- 本地微信数据：通过 OpenCLI `wx-cli` 访问聊天、群成员、统计和朋友圈缓存。
+- 飞书 IM：通过 `lark-cli` 登录、发消息、读消息、搜索消息。
+
+## 安装命令
+
+如果希望直接使用 `wb` 命令，在项目根目录执行：
+
+```sh
+npm link
+```
+
+也可以不用 `wb`，直接使用：
+
+```sh
+npm run start -- 
+