docs: add install command to README
This commit is contained in:
18
README.md
18
README.md
@@ -2,6 +2,14 @@
|
|||||||
|
|
||||||
OpenClaw 微信通路插件 — 通过 WeChat OAuth 扫码登录获取 token,连接 AGP WebSocket 网关收发消息。
|
OpenClaw 微信通路插件 — 通过 WeChat OAuth 扫码登录获取 token,连接 AGP WebSocket 网关收发消息。
|
||||||
|
|
||||||
|
## 安装
|
||||||
|
|
||||||
|
```bash
|
||||||
|
openclaw plugins install @henryxiaoyang/wechat-access-unqclawed
|
||||||
|
```
|
||||||
|
|
||||||
|
重启 Gateway 后生效。
|
||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
|
|
||||||
- 微信扫码登录(终端二维码 + 浏览器链接)
|
- 微信扫码登录(终端二维码 + 浏览器链接)
|
||||||
@@ -10,14 +18,6 @@ OpenClaw 微信通路插件 — 通过 WeChat OAuth 扫码登录获取 token,
|
|||||||
- 邀请码验证(可配置跳过)
|
- 邀请码验证(可配置跳过)
|
||||||
- 支持生产/测试环境切换
|
- 支持生产/测试环境切换
|
||||||
|
|
||||||
## 安装
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
依赖 Node.js v22+,作为 OpenClaw 渠道插件运行。
|
|
||||||
|
|
||||||
## 配置
|
## 配置
|
||||||
|
|
||||||
在 OpenClaw 配置文件的 `channels.wechat-access` 下:
|
在 OpenClaw 配置文件的 `channels.wechat-access` 下:
|
||||||
@@ -38,7 +38,7 @@ npm install
|
|||||||
| 字段 | 类型 | 说明 |
|
| 字段 | 类型 | 说明 |
|
||||||
|------|------|------|
|
|------|------|------|
|
||||||
| `token` | string | 手动指定 channel token(留空则走扫码登录) |
|
| `token` | string | 手动指定 channel token(留空则走扫码登录) |
|
||||||
| `wsUrl` | string | WebSocket 网关地址(留空则使用环境默认值) |
|
| `wsUrl` | string | WebSocket 网关地址(留空使用环境默认值) |
|
||||||
| `bypassInvite` | boolean | 跳过邀请码验证 |
|
| `bypassInvite` | boolean | 跳过邀请码验证 |
|
||||||
| `environment` | string | `production` 或 `test` |
|
| `environment` | string | `production` 或 `test` |
|
||||||
| `authStatePath` | string | 自定义 token 持久化路径 |
|
| `authStatePath` | string | 自定义 token 持久化路径 |
|
||||||
|
|||||||
23
package.json
23
package.json
@@ -1,9 +1,24 @@
|
|||||||
{
|
{
|
||||||
"name": "wechat-access",
|
"name": "@henryxiaoyang/wechat-access-unqclawed",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"description": "简化的企业微信 服务号 接收消息 Demo",
|
"description": "OpenClaw 微信通路插件 — 扫码登录 + AGP WebSocket 双向通信",
|
||||||
"author": "aa",
|
"author": "HenryXiaoYang",
|
||||||
|
"license": "MIT",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/HenryXiaoYang/wechat-access-unqclawed.git"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"index.ts",
|
||||||
|
"auth/",
|
||||||
|
"common/",
|
||||||
|
"http/",
|
||||||
|
"websocket/",
|
||||||
|
"openclaw.plugin.json",
|
||||||
|
"websocket.md",
|
||||||
|
"README.md"
|
||||||
|
],
|
||||||
"openclaw": {
|
"openclaw": {
|
||||||
"extensions": [
|
"extensions": [
|
||||||
"./index.ts"
|
"./index.ts"
|
||||||
@@ -26,7 +41,7 @@
|
|||||||
"order": 85
|
"order": 85
|
||||||
},
|
},
|
||||||
"install": {
|
"install": {
|
||||||
"npmSpec": "@yanhaidao/wechat-access",
|
"npmSpec": "@henryxiaoyang/wechat-access-unqclawed",
|
||||||
"localPath": "extensions/wechat-access",
|
"localPath": "extensions/wechat-access",
|
||||||
"defaultChoice": "npm"
|
"defaultChoice": "npm"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user