# onkel

> A commandline calender inspired by cal and ncal.

Latest version **0.3.3** (published 2021-05-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install onkel
pnpm add onkel
yarn add onkel
bun add onkel
```

Provides the command `onkel`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2021-05-03 |
| First published | 2018-10-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 180.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Moritz Rebbert |
| Maintainers | ztiromoritz |

## Links

- npm: https://www.npmjs.com/package/onkel
- npm.io page: https://npm.io/package/onkel

## Dependencies (3)

- [colors](https://npm.io/package/colors.md) ^1.3.2
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [commander](https://npm.io/package/commander.md) ^2.18.0

## Recent versions

- 0.3.3 (latest) — 2021-05-03
- 0.2.0 (beta) — 2018-10-13
- 0.3.2 — 2021-05-03
- 0.3.1 — 2021-05-03
- 0.3.0 — 2021-04-29
- 0.2.6 — 2020-09-19
- 0.2.7 — 2018-10-15
- 0.2.5 — 2018-10-15
- 0.2.3 — 2018-10-14
- 0.2.2 — 2018-10-14
- 0.1.1 — 2018-10-11
- 0.1.0 — 2018-10-11
- 0.0.2 — 2018-10-11
- 0.0.1 — 2018-10-10

## README

# onkel
A commandline calender inspired by cal and ncal.

<img src="https://raw.githubusercontent.com/ztiromoritz/ncal-js/master/screenshot.png" alt="screenshot" width="360">

## 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](https://momentjs.com/).
```
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
```

---
_Source: https://npm.io/package/onkel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._