README
¶
Matrix reminder and calendar bot - RemindMe
A matrix bot that handles reminders and knows your agenda.
Example
📋 Features
- Schedule reminders
- Edit and delete reminders
- Timezone support
- Natural language understanding
- Quick actions via reactions
- Daily message with open reminders for the day
- Repeatable reminders
- iCal export of all reminders (via API)
- Block users (via API)
- Allow bot to be invited (enable in settings)
- End to end encrypted channels (enable in settings)
The following features are seen as experimental, we do not recommend them for use in production. Data losses or data leaks might happen.
- Multi-User channels
- Import reminders from an Ical link (see API documentation about third party resources)
👩🔧 Contribute
See our contribution guidelines.
🔍 How to use the bot
After you have installed the bot it will invite every user in the config in a channel. Accept the invite and you are ready to interact with it.
New Reminder
To make a new reminder talk to the bot like this:
make laundry at sunday 16:00walking with the dog 6ambrunch with alan at sunday
It tries to understand your natural language as best as it can.
List all available commands
To get all commands just type one of these lines:
commandslist all commandsshow all commandshelp
⚙️ Installation
See our installation guides. We provide docker container images or you can build the binary yourself.
📚 Further documentation
Take a look into our wiki. It provides you with further information and troubleshooting guides.
API
The bot offers an API. It needs to be enabled in the settings where the api key for the "Admin-Authentication" needs to be set.
The documentation can be found at cubicrootxyz.github.io/RemindMe/.
🎁 Related projects
Any project missing? Open a pull request!
- RemindMe-Web - Web UI for controlling the bot
❤️ Attribution
Great thanks to the libraries used in this project:
Directories