memo

🚧 memo 🚀 Under development... 🚧

About   |   Demo   |   Features   |   Technologies   |   Installation   |   Documentation   |   Roadmap   |   License

:dart: About

Memo is a simple command-line interface (CLI) tool for managing your Apple Notes and Apple Reminders. It’s written in Python and aims to offer a fast, keyboard-driven way to create, search, and organize notes and reminders straight from your terminal.

:computer: Demo

 

:sparkles: Features

:heavy_check_mark: View your notes and reminders directly from the terminal
:heavy_check_mark: Edit your notes and reminders right from the terminal
:heavy_check_mark: Add new notes and reminders effortlessly through the terminal
:heavy_check_mark: Move notes to another folder effortlessly through the terminal
:heavy_check_mark: Mark reminders as completed from the terminal
:heavy_check_mark: Export your notes to HTML and convert them to Markdown

:rocket: Technologies

The following tools were used in this project:

• Click
• Mistune
• html2text

:checkered_flag: Installation

Manual Installation

git clone https://github.com/antoniorodr/memo

cd memo

pip install .

Homebrew Installation

brew tap antoniorodr/memo
brew install antoniorodr/memo/memo

:bookmark_tabs: Documentation

:warning: Be careful when using --edit and --move flags with notes that include images/attachments. Memo does not support this yet. Memo will send you a warning if you try to edit a note with images/attachments.

To read the full documentation, please visit the docs

Use the command memo notes --help to see all the options available for notes.

memo notes --help
Usage: memo notes [OPTIONS]

Options:
  -f, --folder TEXT  Specify a folder to filter the notes (leave empty to get
                     all).
  -a, --add          Add a note to the specified folder. Specify a folder
                     using the --folder flag.
  -e, --edit         Edit a note in the specified folder. Specify a folder
                     using the --folder flag.
  -d, --delete       Delete a note in the specified folder. Specify a folder
                     using the --folder flag.
  -m, --move         Move a note to a different folder.
  -fl, --flist       List all the folders and subfolders.
  -s, --search       Fuzzy search your notes.
  -r, --remove       Remove the folder you specified.
  -ex, --export      Export your notes to the Desktop.
  --help             Show this message and exit.

Use the command memo rem --help to see all the options available for reminders.

memo rem --help
Usage: memo rem [OPTIONS]

Options:
  -c, --complete  Mark a reminder as completed.
  -a, --add       Add a new reminder.
  -d, --delete    Delete a reminder.
  --help          Show this message and exit.

You can use memo --help to see the available commands.

memo --help
Usage: memo [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  notes
  rem

Memo uses $EDITOR to edit and add notes. You can set it up by running the following command:

export EDITOR="vim"

Where vim can be replaced with your preferred editor. Add it to your .zshrc/.bashrc to make it permanent.

Or check the one you have set up in your terminal by running:

echo $EDITOR

:pushpin: Roadmap

• Check the roadmap here

:memo: License

This project is under license from MIT. For more details, see the LICENSE file.

:eyes: Do you like my work?

If you like my work and want to support me, you can buy me a coffee ☕ or even a burrito 🌯 by sponsoring me.

Back to top