usage

• adding a note
• listing notes
• reading a note
• editing an existing note
• renaming a note
• removing a note
• using the list index
• removing all remindmes
• help information
• version information

using remindme

adding new notes:

Adding a note is simple:

⇒ remindme --add Title of The Note
[runner]: Enter what you remember now?
> This is some content of the note
>
> You can keep entering content over
> several lines
>
> :end
[runner]: RemindMe will remind you next time.

To exit edit mode, you need to type :end in a separate line. You can also use Cmd/Ctrl + C to exit.

If you have content that you want to add without entering edit mode, you can simply pipe it into remindme.

⇒ echo "content of the note" | remindme --in Another Awesome Note

This is useful, say, you have a file with some content and want to save it as a note.

listing notes:

To see the notes you have added:

⇒ remindme --list
[runner]: Found 1 remindme
1  - Title of The Note

reading a note:

Reading a note is even simpler:

⇒ remindme Title of The Note
[runner]: Reminding you:
1 This is some content of the note
2
3 You can keep entering content over
4 several lines

If you want to get the raw, unmodified content without colors, status information, etc., use the -o/--raw flag. This is useful when you want to pipe the content to some other process.

⇒ remindme Title of The Note --raw
This is some content of the note

You can keep entering content over
several lines

editing an existing note:

Editing an existing note is simple too. Although we need an external editor for this.

⇒ remindme --edit Title of The Note

renaming a note:

A simple format for this command would be:

⇒ remindme old title --rename new title

removing a note:

We may require to remove a note:

⇒ remindme --remove Title of The Note
[runner]: remindme successfully removed

using the list index:

When you list the remindmes with --list, they are numbered in the list shown. To allow faster operations, the number, here referred to as the index, can be used instead of the title. You just have to use --index to tell remindme, that it is an index.

For example,

⇒ remindme --index --remove 2
[runner]: remindme successfully removed

Note: These indices change with additions and removal of other notes since the list is kept ordered alphabetically. Do not assume a remindme has the same index, without checking first.

removing all remindmes:

Removing all remindmes (TAKE CARE):

⇒ remindme --remove-all

help information:

See help information with:

⇒ remindme --help

version information:

Version information can be seen with:

⇒ remindme --version