alesplin / hey

CLI tool to create alarmed reminders
0 stars 0 forks source link

NOTE: yo has been (hopefully temporarily) taken down until I find out whether I can post stuff like this legally as an Apple Employee.

################################################################################

Name: yo

Author: Alex Esplin

Purpose: CLI tool to create alarmed reminders.

Copyright: 2013 Alex Esplin

#

License: This work is licensed under the Creative Commons

Attribution-ShareAlike 3.0 Unported License. To view a copy

of this license, visit

http://creativecommons.org/licenses/by-sa/3.0/.

################################################################################

'yo' is a simple tool to create reminders on the command-line. It uses a simple time spec to create a reminder at either a relative offset to the current time (all offsets are treated as positive) or at a specified date/time.

It uses the EventKit framework to create a reminder with an alarm based on the time spec detailed in the help message (yo --help).

################################################################################

Installation

################################################################################ To install: run the provided install script

./install.sh

This will require the command-line tools from Xcode. It will build the project and install the app in a directory named 'bin' in your home directory (bin will be created if it does not already exist).

The easiest way to use it is to then create an alias:

alias yo="${HOME}/bin/yo.app/Contents/MacOS/yo"

################################################################################

Usage

################################################################################

Usage: yo [time-spec]

Where:

time-spec is one of the following types:

    +[<count>[w|d|h|m|s]]
        (reminder time relative to now)

    @<[yyyy/mm/dd_]hh:mm[:ss]
        (reminder at given date/time)

<message> is a quoted string to use as the reminder text.

Examples:

yo +45m 'some message'
    reminder 45 minutes from now

yo @2013/04/2_12:45 'some message'
    reminder on April 2, 2013, at 12:45

yo 'some message'
    reminder with no alarm/due date/start date