rremind 0.0.14

A simple reminder service inspired by Diane Skoll's 'remind'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# RREMIND

Simple service to remind you, much simpler than -- but inspired by -- Diane Skoll's wonderful tool [remind](https://dianne.skoll.ca/projects/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

``Tue at 11.00 DURATION 1.5 MSG breakfast``, or

``Mon AT 17:00-18:00, Jour Fix with John Dee``.

... or **yearly dates** ...

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

``jan 1 AT 11:00-14:00, Clean up after new year's party``, or

``nov 6 REM Heiko's birthday``

... or **specific dates** ...

``2025 May 17 AT 10:00 DURATION 20 REM Give Annika her birthday present``

``2025 May 17 AT 10.00-10.20, Give Annika her birthday present``

(``Duration`` can be hours or minutes; values > 8 are interpreted as minutes; time is optional and always in 24-hr format, both ":" and "." work as separators of hours and minutes, e.g. ``16.20`` and ``16:20`` are both read as four twenty pm).

``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:\
  <args>
    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)

    A date in ISO or German date format; 

    'when' followed by a search term;

    'when_was' followed by a search term (to look through the archive);

    '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 appointments "taggable" and filter listings by tag and by file.\
    [ ] Color code appointments/tags/files\
    [ ] Special tag `nonblocking` meaning that appointments can still go in that slot\
    [ ] `rremind free 2 hours` to make rremind suggest appointments that take two house\
    [ ] Invent mechanism to manage doodles and the likes (i.e. block dates and unblock when date is fixed).
[ ] 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.\
[ ] "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.