PushMe 官方插件仓库。App 内置的「插件商店」直接读这里的 index.json,
在 App 里点一下就能装,不用手动复制代码。
下表由
node gen-index.js自动生成,请勿手改。新增插件后跑一次脚本即可。 「依赖」列是插件用到的内置方法(PMF.xxx),装完要在 App 的插件设置里打开,否则插件会跳过或报错。
| 插件 | 说明 | 分类 | 依赖 | 版本 |
|---|---|---|---|---|
| AES加解密示例 | 用随机密钥对标题做一次 AES 加密再解密,演示 PMF.aes 用法 | — | PMF.toast、PMF.aes | 1.0.0 |
| 智能主题 | 根据标题关键词自动打上 失败/告警/成功/信息 主题,关键词可用环境变量覆盖 | 主题 | — | 1.1.0 |
| 内容解码(base64) | type 里带 base64 时把正文当 base64 解码,并把真实类型还原回去 | 安全 | PMF.base64 | 1.0.0 |
| 文本转图表 | 把「标签 数值」的多行文本转成柱状/饼图,服务端不用改推送格式 | 类型转换 | — | 1.1.0 |
| 每日签到 | 配合「定时任务」每天固定时间触发:自动请求签到接口;没配接口就退化成一条可点开的签到提醒 | 定时任务 | PMF.fetch | 1.0.0 |
| 分组头像 | 按分组名给消息挂上头像,用 [#分组!头像URL] 语法,头像会被下载缓存 | 分组 | — | 1.0.0 |
| 消息验签(md5) | type 里带 md5 时校验正文签名,通过则去掉签名行,失败给标题打上失败主题 | 安全 | PMF.md5 | 1.0.0 |
| 丢弃未处理通知 | 放在插件列表最后。经过前面所有插件后仍是 notify 类型的消息(没有被通知转文本等插件接管),改成 task 让 App 丢弃,不在消息列表里留 JSON 垃圾 | 通知 | — | 1.0.0 |
| 通知转文本 | 把「通知监听」转发进来的消息转成普通文本,不再在消息列表里显示一大段 JSON | 通知 | — | 1.0.0 |
| 消息type转换 | 把 chart 类型改成 echarts(正文需已经是 ECharts option 的 JSON),服务端不用改推送格式 | 类型转换 | — | 1.0.1 |
| 交警贴条提醒 | 短信里出现车牌号或「交警」就切到指定通道,并把车牌所在的那句话提取成标题 | 通知 | — | 1.1.0 |
| 插件运行时间 | 把整条插件链的耗时附加到标题末尾,建议放在插件列表第一个 | 调试 | PMF.toast | 1.0.2 |
| RSA加解密示例 | 用内置公钥对标题做一次 RSA 加密再解密,演示 PMF.rsa 用法 | — | PMF.toast、PMF.rsa | 1.0.0 |
| 智能设置通道 | 按环境变量里配置的关键词把消息投到指定通道,不用改代码 | 通道 | — | 1.1.0 |
| 智能设置分组 | 按环境变量里配置的关键词给消息打上分组,不用改代码 | 分组 | — | 1.1.1 |
| 关键词静默 | 命中关键词(且在设定时段内)的消息不弹通知,只安静地进 App | 免打扰 | — | 1.0.0 |
| 网站监控 | 配合「定时任务」定时检测一批网址,只有出现非 200(或请求失败)时才发通知,全部正常就静默 | 定时任务 | PMF.fetch | 1.0.0 |
| 定时任务转待办 | 把定时任务触发的消息转成待办清单,每行一个可勾选的待办项 | 定时任务 | — | 1.0.0 |
| 纯链接转 URL | 正文就是一个链接时改成 url 类型,点通知直接打开浏览器 | 类型转换 | — | 1.0.0 |
| 转发到 Webhook | 把每条消息 POST 到钉钉/飞书/自建接口,异步发送,不拖慢消息链路 | 转发 | PMF.fetch | 1.0.0 |
插件是洋葱模型(compose):列表第 1 个在最外层,next() 之前按列表顺序往里走,
next() 之后按倒序往外返回。所以「排在前面」≠「一定最先生效」——写在 next() 后面的代码是最后才执行的。
一套通用组合:
| 顺序 | 插件 | 为什么在这个位置 |
|---|---|---|
| 1 | 插件运行时间 | 洋葱模型的最外层:next() 之后才拿到耗时,排第一才量得到整条链(排最后永远是 0ms) |
| 2 | 交警贴条提醒 | 最紧急的路径,要抢在「智能设置通道」前面占住通道标记(后面那个看到已有通道就不动了) |
| 3 | 内容解码(base64) | 先把正文解出来,后面所有插件才能看到真实内容 |
| 4 | 消息验签(md5) | 验签算的是解码后的正文,必须排在 base64 之后 |
| 5 | 通知转文本 | 把通知监听转发进来的 JSON 换成正文 |
| 6 | 每日签到 | 只接管任务名带「签到」的定时任务,必须排在「定时任务转待办」前面 |
| 7 | 网站监控 | 只接管任务名带「监控」的定时任务,同样要排在「定时任务转待办」前面 |
| 8 | 定时任务转待办 | 接管剩下的定时任务(不接管的话 App 会丢弃这条消息) |
| 9 | 智能设置分组 / 智能设置通道 | 按关键词归类 |
| 10 | 分组头像 | 依赖上一步分好的组名,必须排在它后面 |
| 11 | 智能主题 | 给标题打上成功/失败/告警标记 |
| 12 | 纯链接转 URL、文本转图表 | 类型转换,放最后不影响前面的判断 |
| 13 | 转发到 Webhook | 把最终形态的消息转发出去 |
| 14 | 丢弃未处理通知 | 兜底:经过前面所有插件后仍是 notify 的消息改成 task 让 App 丢弃,不留在消息列表里变 JSON 垃圾 |
「每日签到」「网站监控」「定时任务转待办」都会接管
task消息,先执行的赢。 签到插件默认只处理任务名里带「签到」的(CHECKIN_TASK_KEYWORD), 网站监控默认只处理任务名里带「监控」的(WATCH_TASK_KEYWORD), 所以三者可以同时装:各管各的任务,剩下的任务归待办插件。
type 除了填正常类型,还可以用 + 连接修饰符,插件处理完会把真实类型还原回去:
| 写法 | 含义 |
|---|---|
base64+text |
正文是 base64,解码后按 text 显示 |
md5+markdown |
正文带 md5 签名,校验通过后按 markdown 显示 |
base64+md5+text |
先 base64 解码,再验签,最后按 text 显示 |
签名约定:正文 + 空行 + 单独一行 -- + 32 位十六进制 md5,
签名值 = md5(正文 + MD5_SECRET),没配 MD5_SECRET 时就是 md5(正文)。
没装对应插件时,type 是这种写法会被 App 当成未知类型、退化成 text 显示,
所以这两组修饰符是「装了才生效、不装也不会坏」的。
| 插件 | 变量 | 格式 |
|---|---|---|
| 智能设置分组 | GROUP_RULES |
分组A=词1,词2;分组B=词3 |
| 智能设置通道 | CHANNEL_RULES |
特别关注=词1,词2;工作=词3 |
| 智能主题 | THEME_RULES |
f=失败,出错;w=告警,注意(覆盖默认词表) |
| 分组头像 | FACE_RULES |
分组A=https://a.png;分组B=https://b.png |
| 消息验签 | MD5_SECRET |
任意字符串,留空则只校验内容本身 |
| 关键词静默 | SILENT_KEYWORDS / SILENT_TIME |
广告,推广 / 23:00-07:00(可留空) |
| 每日签到 | CHECKIN_API / CHECKIN_METHOD |
签到接口地址 / POST(默认)或 GET;不填接口就只发提醒 |
| 每日签到 | CHECKIN_HEADERS / CHECKIN_BODY |
JSON 请求头,如 {"Cookie":"sid=1"} / 请求体 |
| 每日签到 | CHECKIN_KEYWORD / CHECKIN_LINK / CHECKIN_TIP |
判定成功的关键词(不填按 HTTP 状态码)/ 签到页地址 / 提醒文案 |
| 每日签到 | CHECKIN_TASK_KEYWORD |
只接管任务名含该词的定时任务,默认「签到」 |
| 交警贴条提醒 | ALERT_CHANNEL / PLATE_EXTRA |
通道名,默认「交警」/ 额外车牌,逗号分隔 |
| 交警贴条提醒 | TITLE_MAX |
标题最多几个字,默认 60,填 0 不截断 |
| 转发到 Webhook | WEBHOOK_URL / WEBHOOK_FORMAT |
地址 / custom、dingtalk、feishu |
| 文本转图表 | CHART_TYPE / CHART_SIZE |
bar、pie、line,留空用 bar / 图表尺寸,留空用 App 默认的 10 |
| 网站监控 | WATCH_URLS |
要监控的地址,换行/逗号/空格分隔,只认 http(s):// 开头的 |
| 网站监控 | WATCH_TASK_KEYWORD / WATCH_TIMEOUT |
只接管任务名含该词的定时任务,默认「监控」/ 单个地址超时毫秒,默认 2000 |
| 网站监控 | WATCH_BODY_KEYWORD |
返回内容必须包含它才算正常,用来识破「200 但是登录页」 |
| 网站监控 | WATCH_OK_MODE / WATCH_TITLE / WATCH_GROUP |
全部正常时:drop(默认,静默)、markdata(只进 App)、text(也发通知)/ 异常标题 / 换掉分组名 |
监控逻辑在插件里,触发靠 App 的定时任务,所以要建一个定时任务来定期叫它:
- 抽屉 →「定时任务」→ 新建,名字里带**「监控」**二字(如「网站监控」),
cron 按需要填,比如每 10 分钟一次就是
*/10 * * * *。 任务内容随便写,插件不读它。 - 在环境变量里配
WATCH_URLS,一行一个地址:https://example.com https://api.example.com/health - 装这个插件,并且排在「定时任务转待办」前面 —— 两者都吃
task消息,先执行的赢。 插件只接管任务名带「监控」的任务,所以和「每日签到」可以共存。
默认只有出现异常才发通知(标题 [f]网站监控异常 (1/3),正文逐条列出哪个地址、什么原因);
全部 200 时这条消息会被 App 静默丢弃,不留记录。想让每次检测都留个痕,把 WATCH_OK_MODE
设成 markdata(只进 App 不弹通知)。
判定规则:状态码不是 200 就算异常,请求本身失败(DNS、超时、证书错误)也算,
status 会是 -1。配了 WATCH_BODY_KEYWORD 时,200 但内容里没有这个词同样算异常 ——
适合抓「登录态过期返回登录页」这种假正常。
检测用的是同步
PMF.fetch(必须同步才能把结果写进消息),所以整条链路会被卡住 「地址数 × 超时」那么久,期间消息不入库也不通知。地址别配太多,WATCH_TIMEOUT别给太大。
语音播报和循环通知都是通道上的设置,插件只负责把消息投到那个通道,所以要先把通道准备好:
- 先让 App 建出这个通道:给自己发一条标题带
[~交警]的消息(发送页直接发就行), Android 会自动建出名为「交警」的通道。 - 抽屉 →「通知通道」→ 展开「交警」→ 打开语音通知和重复通知。 重复间隔在消息设置里(默认 30 分钟)。
- 打开「通知监听」,并在应用过滤里勾上短信 App —— 短信是靠监听短信应用的通知进来的。
- 装这个插件(建议排在插件列表第二位,紧跟「插件运行时间」)。
通道名要和 ALERT_CHANNEL 完全一致(区分大小写),名字里别带空格和特殊字符,
它同时也是 Android 的 channel id。
标题怎么来的:命中之后插件把正文按 。!?; 切成句子,取含车牌(或「交警」)的那一句
当标题,顺手剥掉 [2条]、【河南省交警】 这类前缀 —— 原来的发送号码(如 121234103)不再当标题。
超长的句子按 TITLE_MAX 截断,完整原文仍然在正文里。
插件命中条件:正文里出现车牌号(含新能源 8 位)或**「交警」**二字。
想连自己的车牌一起盯,就把车牌填进 PLATE_EXTRA。
PushMe → 插件 → 右上角商店图标 → 选插件 → 安装。
装完之后可以在插件列表里调整顺序、临时关掉,也可以点进去改代码(改过之后商店会标成「本地已修改」, 再更新时会提示覆盖)。
需要配置的规则请写进环境变量,不要改代码:改过代码的插件会被标成「本地已修改」, 下次商店更新会覆盖你的改动。
一个插件就是一个 .js 文件,放在 plugins/ 下。文件头写一段 JSDoc,正文是裸函数表达式。
不想从头写就复制 plugins/_template.js(_ 开头的文件不会被收录进商店)。
/**
* @key pushme.my_plugin
* @name 我的插件
* @description 一句话说明这个插件做什么
* @author 你的名字
* @version 1.0.0
* @tags 分组
* @dependencies PMF.toast
* @env MY_KEY
*/
function(msg, next) {
msg.title = '[#我的分组]' + msg.title
next()
}msg 只有四个字段可以改:title / content / date / type,next() 把消息交给下一个插件。
几条硬性要求,违反的话 App 会拒绝安装、或者让所有插件一起失效:
- 必须是裸函数表达式,不能是
module.exports = ...,也不要在末尾加分号。 App 是把所有插件的源码用plugins.push(...)拼成一个 JS 程序跑的,多一个;就是语法错误。 - 不要在函数外面声明变量或函数。同理,所有插件共享一个 JS 程序,两个插件都写
const KEY = 'x'会直接语法错误。所有代码都放进function(msg, next) { ... }里面。 - 不能出现
require(/module.exports。 - 改代码就要升
@version,否则用户永远收不到更新(脚本会直接报错拦住你)。 - 别把密钥写进代码。用
@env声明需要的环境变量,让用户自己填。
@key 建议显式写死(pushme.xxx):默认取文件名,改了文件名就等于换了个插件,
用户那边会变成装了个新的、旧的还留着。
三个容易踩空的心智模型(详细见 PLUGIN-SPEC.md):
- 插件无状态。每条消息都会新开一个 JS 上下文,
let count = 0这种计数下次就归零了。 - 异步改不了消息。
PMF.fetch.asyncPost()返回时消息已经入库了,异步结果只能用来做副作用(转发、通知第三方)。 - 不调
next()就是截断,后面的插件都不会执行;反过来,想在某个条件下「什么都不做」,就用return next()提前退出。
node gen-index.js会做三件事:扫描 plugins/、重建 index.json、刷新上面那张表。
push 之后 GitHub Actions 也会跑一遍并把结果提交回来,所以本地忘了跑也不影响。
脚本会拦住两种手滑:
- 内容改了但
@version没升 → 失败 versionCode比上一版小 → 失败