📖 介绍
这是一个提供符合中国宝宝体质的定时提醒功能的插件。
💿 安装
使用 nb-cli 安装
在 nonebot2 项目的根目录下打开命令行, 输入以下指令即可安装nb plugin install nonebot-plugin-remind
使用包管理器安装
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令pip
pip install nonebot-plugin-remind
打开 nonebot2 项目根目录下的 pyproject.toml 文件, 在 [tool.nonebot] 部分追加写入
plugins = ["nonebot_plugin_remind"]
⚙️ 配置
在 nonebot2 项目的.env文件中添加如下可选配置
| 配置项 | 必填 | 默认值 | 说明 |
|---|---|---|---|
remind_private_list_all |
否 | True |
私聊中"/提醒列表"命令是否列出私聊群聊全部提醒 |
remind_keyword_error |
否 | True |
触发“提醒”关键词时是否发送错误提示 |
remind_llm_api_key |
否 | "" |
大模型 API Key(OpenAI 兼容接口;留空则禁用大模型兜底;需安装 [llm] 附加依赖) |
remind_llm_base_url |
否 | "" |
大模型接口地址,例如智谱:https://open.bigmodel.cn/api/paas/v4;留空使用 SDK 默认(api.openai.com) |
remind_llm_model |
否 | "" |
用于解析提醒时间的模型名称(可对接任意兼容平台) |
大模型兜底为可选能力:需先安装附加依赖
pip install nonebot-plugin-remind[llm];支持任意兼容 OpenAI Chat Completions 协议的服务(智谱、DeepSeek、硅基流动、本地 vLLM 等)。
从 0.1.x 升级:0.3.0 起不再兼容 0.1.x 写下的任务文件。启动时若检测到旧格式文件,会转存一份带时间戳的备份(同目录
remind_tasks.corrupt-<时间>.json)并以空任务集启动,旧提醒请重新设置。
🎉 使用
关键词触发
提醒
触发格式(支持两种语序):
[@][时间]'提醒'[被提醒人][消息]
[@]'提醒'[被提醒人][时间][消息]
各部分解释:
-
[@](以下条件任意满足一条即可)
- 在消息开头@机器人
- 回复机器人的任意一条消息
- 如果机器人设置了
NICKNAME环境变量,则只需在消息开头称呼其昵称 - 在私聊中,可以省略此部分,见文末示例图
-
[时间]
关键词触发和命令触发均使用 jionlp 进行自然语言时间解析,支持以下格式:
明天下午3点、后天上午10点、下周一9点半小时后、10分钟后、两个小时后春节、国庆节、中秋节2025-1-1 8:00、9月10日18:00、21:12- ……
安装
[llm]附加依赖并正确配置remind_llm_api_key与remind_llm_model之后,jionlp 无法解析的时间表达式将由大模型(OpenAI 兼容接口)兜底解析,你将获得更自由更符合人类语言的丰富体验,包括但不限于:明天晚上八点1刻20分钟后下周三的同一时间今年的教师节早上八点10月1日提前10天的正午12点- ……
特别提醒: 简单需求使用轻量模型即可满足。越复杂的时间描述(如
一坤时后)对大语言模型的理解能力需求越高,请结合所选平台自行选择合适的模型。除此之外,时间部分还支持循环提醒的设置(jionlp 可直接识别周期性时间表达式):
每年3月12日7:00每月22日22:00每周一三五18:00每天15:00、每小时每2小时、每隔30分钟
(
每 N 分钟/小时/天/周等间隔表达从设置时刻起算,例如 10:07 设置每隔30分钟,会在 10:37、11:07 …… 依次提醒。)- 特别提醒: 循环与间隔表达(如
每隔2小时)的解析与单次共用同一个模型与同一条提示词,对模型能力要求更高,这种场景下建议选择能力较强的模型。
-
'提醒': 要匹配的关键字,必须完全一致
-
[被提醒人](以下格式均符合要求)
我:提醒设定提醒的人自己[@]:可以@多个用户,包括自己,也可以@全体成员我和[@]:必须我在前面,其他@用户在后all或者所有人: 等同于@全体成员,提供一个非打扰式的提醒设定
-
[消息]
- 任意消息(支持图片、QQ黄脸表情等富文本消息)均可,前提是必须在同一条消息中发送出
示例:
@机器人 16:00提醒我去开会@机器人 提醒我明天下午3点去开会@机器人 提醒我半小时后喝水机器人昵称,1月1日11:40提醒所有人去聚餐机器人昵称 2025年1月29日8:00提醒我和@用户1 用户2 新年新气象!
指令触发
以下触发均需要指令前缀,如未设置默认为/。
提醒
-
提供1个参数为
被提醒人,以交互的方式设置提醒: -
提供3个参数,以英文逗号
,间隔,依次为:被提醒人,时间和提醒消息:
以上两种命令的触发方式均可省略
被提醒人参数,省略时默认被提醒人为“我”。
提醒列表(单次提醒列表)
列表顺序默认按提醒时间顺序排序,使用 -s 选项按设置提醒的先后顺序排序
当在群聊中触发此指令时,仅返回在群聊内设置的提醒。
当在私聊中触发此指令时,返回所有私聊和群聊中设置的提醒。
注意:当配置环境变量 remind_private_list_all=false 时,私聊时也仅返回私聊中设置的提醒。
循环提醒列表
此命令只会输出设置的循环提醒任务,不支持 -s 选项的排序,默认按照设置顺序排序。
删除提醒(删除单次提醒)
使用的列表顺序默认按提醒时间顺序排序,使用 -s 选项按设置提醒的先后顺序排序的序号删除
注意:在删除提醒之前一定要先通过
/提醒列表指令查看序号!每次删除后后续序号都会更新!
示例:
/删除提醒 1:删除序号为1的提醒(默认按提醒时间排序)/删除提醒 -s 1-3 5:批量删除序号为1、2、3、5的提醒(按设置时间排序)/删除提醒 all:一键删除所有提醒(仅当前群聊)
删除循环提醒
与 /删除提醒 命令用法相同,同样不支持 -s 选项排序,必须提供由 /循环提醒列表 命令查看得到的任务序号。
示例图
本示例,均为未启用大模型兜底的情况下,基于 jionlp 进行时间解析所实现的。
| 提醒命令示例图 | 提醒关键词示例图 | 提醒列表命令示例图 | 删除提醒命令示例图 | 私聊使用示例图 |
|---|---|---|---|---|
|
|
|
|
|
|
Metadata
Release files for nonebot-plugin-remind 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| nonebot_plugin_remind-0.3.0.tar.gz | 27.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nonebot_plugin_remind-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.5 kB
Release files / nonebot_plugin_remind-0.3.0.tar.gz
| Download URL | nonebot_plugin_remind-0.3.0.tar.gz |
|---|---|
| Size | 27.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
78118e479d20eb626af0a8cc999ccf346c68728eba9a4b97c9cf5aa82b4ac830
|
|
BLAKE2b-256 checksum How to use checksums |
1a85fd40964777a74858a619259487ce2ac11f6eb9d7df258d734a64335753d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.
Transparency logRelease files / nonebot_plugin_remind-0.3.0-py3-none-any.whl
| Download URL | nonebot_plugin_remind-0.3.0-py3-none-any.whl |
|---|---|
| Size | 28.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
53182e341e68d113e9f9d25adadeeb163ca165ac9310042ed6dc26828e2db712
|
|
BLAKE2b-256 checksum How to use checksums |
e1603de0c2b19cdbb07142730108055ec9c3d2b9b2efa84484799963bd6b812c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.
Transparency log