Home

Awesome

Matrix reminder and calendar bot - RemindMe

GitHub license GitHub issues Actions Status

Logo

A matrix bot that handles reminders and knows your agenda.

⚠️ The main branch currently contains the v2 which is not backwards compatible. v1 is moved to the similiar named branch. ⚠️

Example

Example chat interaction

📋 Features

Not yet ported to v2:

The following features are seen as experimental, we do not recommend them for use in production. Data losses or data leaks might happen.

👩‍🔧 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:

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:

⚙️ 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.

Currently the documentation is not provided in a human readable way.