An open API service indexing awesome lists of open source software.

https://github.com/antoniorodr/memo

CLI app to manage your Apple Notes and Apple reminders
https://github.com/antoniorodr/memo

applenotes applereminders cli python terminal-based

Last synced: 11 days ago
JSON representation

CLI app to manage your Apple Notes and Apple reminders

Awesome Lists containing this project

README

        


memo

 


memo


Github top language

Github language count

Repository size

Github issues

Github forks

Github stars


🚧 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


asciicast

## :sparkles: Features

:heavy_check_mark: View your notes and reminders directly from the terminal\
:heavy_check_mark: Edit your notes 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

## :rocket: Technologies

The following tools were used in this project:

- [Click](https://click.palletsprojects.com/en/stable/)
- [Mistune](https://mistune.lepture.com/en/latest/)
- [html2text](https://pypi.org/project/html2text/)

## :checkered_flag: Installation

#### Manual Installation

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

cd memo

pip install .
```

#### Homebrew Installation

```bash
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.

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

```bash
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.
--help Show this message and exit.
```

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

```bash
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.

```bash
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:

```bash
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:

```bash
echo $EDITOR
```

## :pushpin: Roadmap

- Possibility to remove a folder

## :memo: License

This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.

## :eyes: Do you like my work?

Buy Me A Coffee

Made with :heart: by Antonio Rodriguez

 

Back to top