#calendar #cli #remind

app rremind

A simple reminder service inspired by Diane Skoll's 'remind'

4 releases

0.0.5 Oct 30, 2024
0.0.4 Oct 12, 2024
0.0.3 Oct 7, 2024
0.0.1 Oct 3, 2024

#252 in Command line utilities

Download history 123/week @ 2024-09-30 322/week @ 2024-10-07 44/week @ 2024-10-14 117/week @ 2024-10-28

487 downloads per month

GPL-3.0-only

42KB
882 lines

RREMIND

Simple service to remind you, much simpler than -- but inspired by -- Diane Skoll's wonderful tool remind

Introduction

Pick a folder to store your appointments and the dates you would like to be reminded of. Populate this folder with text files whose names end in ".rem".

These files can contain weekly dates...

Mon AT 17:00 DURATION 1 MSG Jour Fix with John Dee

... or yearly dates ...

jan 1 AT 11:00 DURATION 3 MSG Clean up after new year's party

nov 6 REM Heiko's birthday

... or specific dates ...

2024 November 5 AT 10:00 DURATION 20 REM Buy myself a birthday present

(Duration can be hours or minutes; values > 8 are interpreted as minutes; time is optional)

rremind will ask for the location of your .rem-files on the first run -- or the location can be altered later using rremind config.

You can then retrieve dates of specific days or periods, or find appointments by name (e.g. 'dentist').

Installation

Cargo install rremind

Archlinux

yay -S rremind

Usage

rremind

Arguments:
Integer value of day relative to today;

A range of two integers (e.g. -1..2) to list all appointments between yesterday and the day of tomorrow (inclusive)

'when' followed by a search term;

'check' to check if all .rem-filed can be interpreted

'config' to change the settings

'archive' to archive all appointments that are in the past

'version' to get the version number of your installation

'help' for a brief help message.

Without any arguments, ``rremind`` will show today's appointments.

Future

Next steps:

[ ] Make "archive" accept a parameter specifying how old the appointments need to be for archiving. [ ] Make archive configurable so that it collects all archives in one file. [ ] Make archive report what it's doing [ ] "sort" command to sort the rem files chronologically. [ ] "put" command to add appointments. [ ] Accept date-range input: rremind 0..7 to show appointments of the next 7 days. [ ] Make date format more flexible. [ ] Add nicely formatted output (for terminal). [ ] Add .deb package.

Dependencies

~1MB
~18K SLoC