remindee-bot

用于管理提醒的 Telegram 机器人。

安装

0. 使用 @botfather 设置您的机器人。

方法 1：Rust 的包管理器

1. 安装 Rust。

2. 安装软件包并启动机器人

   cargo install remindee-bot
   remindee-bot --token <BOT TOKEN> --database <FILE>
   

   您可以使用环境变量而不是标志来指定令牌和数据库位置

   export BOT_TOKEN=<BOT TOKEN>
   export REMINDEE_DB=<FILE> # default is to store in the user's data directory
   remindee-bot
   

方法 2：发布存档

1. 从 最新发布页面 下载适用于您的系统架构的存档。

2. 解压存档

   • 对于 Linux，您可以使用 tar xf remindee-bot-<version>-<architecture>.tar.gz 命令；
   • 对于 macOS，您可以使用默认的 zip 提取程序或运行 unzip remindee-bot-<version>-<architecture>.zip 命令；
   • 对于 Windows，您可以使用默认的 zip 提取程序。

3. 导航到目录并启动机器人

   cd remindee-bot-<version>-<architecture>
   ./remindee-bot --token <BOT TOKEN> --database <FILE>
   

方法 3：Docker 容器

1. 从该仓库构建镜像

   docker build --tag remindee-bot 'https://github.com/magnickolas/remindee-bot.git#master'
   

2. 从构建的镜像初始化并运行容器

    docker run -d -v <LOCAL DATABASE DIRECTORY>:/data -e BOT_TOKEN=<BOT TOKEN> remindee-bot
   

   有关更多信息，请参阅 Docker 文档。

方法 4：从源代码

1. 安装 Rust。

2. 使用 Git 克隆仓库

   git clone https://github.com/magnickolas/remindee-bot
   

3. 构建软件包并启动机器人

   cargo install --path remindee-bot
   remindee-bot --token <BOT TOKEN> --database <FILE>
   

使用机器人

向机器人发送 /start 命令并按照其指示操作 🤖。

设置提醒

格式描述和示例可以在 readthedocs 或 docs/index.rst 查看。

您还可以参考Pest 语法游乐场来尝试一些提醒，并查看它们是如何被解析的（在第二个代码块旁边的选择列表底部选择reminder，然后进行操作）。