remindme

README

remindme

remindme is a simple cli you can use to create remind(1) tasks using natural language. It's inspired by Slack's /remind function.

If you want to use remindme, but have no idea what remind is, here's a nice and rather complete explanation.

installation

You can install it from the AUR, using your favorite AUR helper. The package name is remindme-git. For instance:

$ yay -S remindme-git

Otherwise, you need to have the Go compiler installed. Then you can simply run:

$ go install git.sr.ht/~primalmotion/remindme@master

usage

For instance:

$ remindme to get a coffee in 10m
$ remindme to leave at 5pm
$ remindme to get the garbage out next monday at 8pm

By default, remindme will insert the task in ~/.reminders/remindme.rem. You can change this by passing the --file flag.

If you just want to print the reminder on stdout instead of writing it in the target file, you can pass - as value to the--file flag:

$ remindme to get the garbage out next monday at 8pm --file -
REM 2022/04/18 AT 20:00 MSG get the garbage out

reloading

When remind is used with the -zN option, remindme can be instructed to take the necessary steps to have remind reload its configuration after the new reminder has been added. This can be done by touching the remind folder, or by sending a REREAD command to remind's stdin through a named pipe.

This is not needed if remind is configured to use a single file instead of a folder.

touch

You can provide the path to the folder containing your rem files using --touch. remindme will touch the folder so remind can pick up the changes.

$ remindme to reload my reminders in 2m --touch ~/.reminders/

named pipe

If you start remind using the -z0 flag, it will listen for commands on stdin. You can use a named pipe to be able to write to stdin:

$ mkfifo ~/.cache/remind.fifo
$ tail -f ~/.cache/remind.fifo | remind -z0 <...>

You can then tell remindme to write the REREAD command in that named pipe right after adding a new reminder by setting the --pipe flag:

$ remindme to reload my reminders in 2m --pipe /path/to/remind.fifo

config file

You can also set default values for any flags by creating the config file ~/.config/remindme/config.yaml:

file: ~/.reminders
pipe: ~/.cache/remind.fifo
touch: ~/.reminders
silent: true

The available keys identical the the flags with the -- prefix.

That's it!