countdown

README

countdown

I needed a small countdown util. So I made one

Sends a notification when the time has expired.

This is basically the same as sleep 1s && notify-send, but with progress logging.

$ countdown 10s
countdown: Done waiting for: 10s

$ countdown 1m
countdown: Remaining: 57s

Install

Requires Go 1.18 (or later)

go install -ldflags='-s -w' github.com/jilleJr/countdown@latest

The -ldflag='-s -w' removes debug symbols, reducing the binary size from about 2.5M down to 1.6M.

Usage

$ countdown --help
Usage: countdown <duration>

The <duration> argument is a Go time.Duration formatted string.
Examples:

  countdown 10s        // 10 seconds
  countdown 10m        // 10 minutes
  countdown 1m30s      // 1 minute and 30 seconds
  countdown 1h20m30s   // 1 hour, 20 minutes, and 30 seconds

Flags:
      --color string     Colored output, either "always", "never", or "auto" (default "auto")
  -h, --help             Show this help text
  -m, --message string   Show a custom message when the time runs out
      --no-notify        Disables notification via notify-send

License

Written and maintained by @jilleJr. Code is licensed under the GNU GPL 3.0 or later, with misc. documents licensed under CC0 1.0.

This repository is REUSE compliant.