https://github.com/vajahath/periodic-notifier

A CLI to notify you something periodically.
https://github.com/vajahath/periodic-notifier

nodejs notifications notifier npm npm-package periodic reminder

Last synced: 4 months ago
JSON representation

A CLI to notify you something periodically.

• Host: GitHub
• URL: https://github.com/vajahath/periodic-notifier
• Owner: vajahath
• License: mit
• Created: 2017-04-26T11:32:41.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-28T10:10:31.000Z (almost 8 years ago)
• Last Synced: 2025-01-19T01:43:46.947Z (6 months ago)
• Topics: nodejs, notifications, notifier, npm, npm-package, periodic, reminder
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/periodic-notifier
• Size: 182 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# periodic-notifier

A CLI to notify you something periodically

[![npm](https://img.shields.io/npm/v/periodic-notifier.svg)]()

[![styled with prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![npm](https://img.shields.io/npm/dt/periodic-notifier.svg)]()

[![Built with generator-ts-np](https://img.shields.io/badge/scaffolding-ts_np-2699ad.svg)](https://github.com/vajahath/generator-ts-np)




![](media/time.png)

## Install

```

npm i -g periodic-notifier

```

#### How it looks?

![periodic-notifier in action](media/feed_cat.png)

## Usage

To know usage, try running

```

periodic-notifier --help

```

will give you a quick guide.

```

Usage: periodic-notifier [options]

  Options:

    -V, --version           output the version number

    -I --interval     Interval at which the notification should be fired. To know more about time formats see docs.

    -T --title [title]      Title of the message

    -M --message   Actual message

    -C --icon         absolute path to icon.png

    -S --sound              set this flag to make sound

    -W --wait               set this flag to wait the notification

    -h, --help              output usage information

```

### Possible `` formats

Following are the values you can use with `-I` or `--interval` option:

- '2 days'

- '1d'

- '10h'

- '2.5 hrs'

- '2h'

- '1m'

- '5s'

- '1y'

- '100' (milliseconds)

## Example

```

periodic-notifier -I 5s -T "Feed the cat" -M "Because they are awesome.." -W

```

## Change log

- v1.1.0

  - bug fix with icon

  - works in more node versions.

  - notifies if a new version of the cli is available

  - better docs

- v1.0.0

  - initial release

[![used version of ts-np generator](https://img.shields.io/badge/ts--np-v0.0.19-a5a5a5.svg?style=flat-square)](https://github.com/vajahath/generator-ts-np)

## Licence

MIT © [Vajahath Ahmed](https://twitter.com/vajahath7)