Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 1.93 KB

README.md

File metadata and controls

96 lines (67 loc) · 1.93 KB
Raw

reminders-cli

reminders-cli

Command-line interface that uses natural language processing to parse phrases and interact with Reminders.app.

Getting started

TLDR: run npm i -g reminders-cli and reminders --help.

Usage

$ reminders --help

  Usage
    $ remind <input>
    $ reminders
  
  Options
    --list      - List all reminders (will trigger if no option is provided).
    --complete  - List all reminders and enable a selector to be completed

  Examples
    $ remind me to feed the cats tomorrow at 12:00
    $ reminders --list

Create

$ remind me in two hours to study

Add command

You can see some examples in the date parsing test file.

List

$ reminders --list

List command

Complete

$ reminders --complete

Complete command

🔥 It's also possible to provide a name (or part of) to complete command:

Complete command

Installation

This package requires NodeJS to be installed.

Homebrew

brew install node

Manual

Go to https://nodejs.org/en/download/ and install the latest LTS version.

Installing the package

npm install -g reminders-cli

Development

  1. Install
yarn # or npm install
  1. Run build with auto-reloading
yarn run watch
  1. Try commands
node ./dist/index.js --list # To list reminders
node ./dist/index.js --add "My reminder" 11/11/2017 10:30
node ./dist/index.js --add "My reminder"