Skip to content

The utility for repeatedly displaying notifications in the standard OS way

License

Notifications You must be signed in to change notification settings

thewizardplusplus/motivator

Repository files navigation

Motivator

GoDoc Go Report Card Build Status codecov

The utility for repeatedly displaying notifications in the standard OS way.

Features

  • support for several different tasks for displaying notifications:
    • for each task:
      • support for displaying a task name:
        • automatic generation of a task name, if it was not specified (optionally);
        • add a sequential number to duplicated task names (optionally);
      • support for displaying an icon for each notification:
        • an icon can be specified for:
          • a notification;
          • a task;
          • the entire config;
        • for each notification, the first specified icon is selected in the order above;
      • use for displaying notifications on a schedule:
        • the cron specification:
          • support for seconds in the cron specification (optionally);
        • a delay relative to the last displaying:
      • random selection of a notification for displaying;
      • support for the Spintax format in notifications;
  • support for variable substitution in notifications:
    • use the format of the os.Expand() function;
    • use one common list of variables to substitute in all notifications of all tasks;
  • built-in support for running in the background:
    • the console command for starting and restarting;
    • the console command for stopping;
    • the console command for checking of the current running status.

Installation

$ go install github.com/thewizardplusplus/motivator@latest

Usage

$ motivator -h | --help
$ motivator start [-c PATH | --config PATH]
$ motivator status
$ motivator stop
$ motivator foreground [-c PATH | --config PATH]

Commands:

  • start — start (or restart) displaying notifications in the background;
  • status — check that notifications are being display in the background;
  • stop — stop displaying notifications in the background;
  • foreground — start displaying notifications in the foreground.

Options:

  • -h, --help — show the context-sensitive help;
  • -c PATH, --config PATH — the path to a config file (default: config.json).

Environment variables:

  • NO_COLOR — disable colorful output (applies only to the status command).

Config

Format of the config in the JSON Schema format: docs/config.schema.json.

Example of the config: docs/config.example.json.

License

The MIT License (MIT)

Copyright © 2022 thewizardplusplus

About

The utility for repeatedly displaying notifications in the standard OS way

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages