onkel v0.3.3

onkel

A commandline calender inspired by cal and ncal.

Installation

npm install -g onkel

Some examples:

onkel          # calendar of the current month
onkel -y       # calendar of the current year
onkel 2048     # calendar of the year 2048
onkel -3       # calendar of three month: the last, the current, and the upcomming
onkel 12 1990  # calendar of the December 1990

Highlighting

The current day, if visible, is highlighted in all these examples. You can control these highligting by disable it completly or customize the dates to highlight.

onkel -n       # current month without highlight
# To set custom highlights use -H            
onkel 1981 -H 1981-07-23,1981-07-24

Localization

Onkel only supports gregorian calendar based on moment.js.

onkel -L          # to get a list of all available locales
onkel -l de 1981  # to get the calendar

All Options

Usage: onkel [options] <<month> year>

A commandline calendar inspired by tools like cal, pal and ncal.

Options:

  -v, --version             output the version number
  -l, --locale <locale>     select a locale
  -L, --listLocales         list available locales
  -y, --year                display a calendar for the specified year
  -d, --decoration <mode>   highlight style. one of: underline, color, none. default is color
  -n, --noHighlights        no highlights at all (Overrides -H)
  -H, --highlights [dates]  comma separated lists of dates to highlight
  -c, --columns <number>    number of month per row
  -A, --after <number>      display the number of months after the current month
  -B, --before <number>     display the number of months before the current month
  -3                        display the previous, current and next month surrounding today.
  -h, --help                output usage information