Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

wintermute-cell/remi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Remi

Remi is a straightforward command-line reminder for programmers.


remi mascot

It is designed to be simple and quick to use, to not get in your way. The recommended way to use Remi is to add remi to your shell rc, so the relevant reminders are printed every time you open a terminal emulator.

How to Use Remi

Calling Remi without any arguments prints all relevant reminders.

Beyond that, this is how you use Remi:

  • Add a Reminder: You can add a reminder by specifying a timestamp and a message. Timestamps can optionally contain a specific timestamp. If you want the reminder to appear a certain time before the actual deadline, provide the duration parameter. Without a duration, the reminder will always appear.

    remi add <timestamp> <message>
    remi add <timestamp> <duration> <message>
    • Example:

      remi add 25.12.21@16:30 Christmas party
      remi add 25.12.21 3d Reminder before Christmas  # Quoting is not required!
    • Aliases: "add", "a", "+"

  • List Reminders: You can view all existing reminders.

    remi list
    • Aliases: "list", "l", "ls"
  • Remove a Reminder: You can delete a specific reminder by providing the number next to it from the latest Remi output as an ID. (These may change from run to run, as remi always tries to index incrementally from 0 to N)

    remi remove <reminderId>
    • Aliases: "remove", "r", "rm", "delete", "d", "-"

Installation

git clone https://github.com/wintermute-cell/remi
cd ./remi
go build
./remi

You can then place the remi binary somewhere in your $PATH or make a shell alias pointing to it.

Looking for help packaging!

If you'd like to help by packaging for your platform, I'd gladly accept :)

Usage in Shell Configuration

To have reminders appear when opening a new shell session, you can call the Remi program from your shell configuration file (e.g., ~/.bashrc, ~/.zshrc).

Add the following line to your shell configuration file:

go run /path/to/remi/main.go

By executing this line in the shell configuration, Remi will run automatically when a new shell session is started. It will show relevant reminders based on the current time.

About

Remi is a straightforward command-line reminder for programmers.

Resources

Stars

Watchers

Forks

Languages