countdown

Countdown is terminal based multi-event countdown timer. It uses the Bubble Tea TUI framework from Charm_.

https://user-images.githubusercontent.com/96601789/182011443-15b35466-3969-490c-9f74-b30dcbd29a41.mp4

Installation

Install using Golang's tools

go install github.com/aldernero/countdown@latest

or clone and build

git clone https://github.com/aldernero/countdown.git
cd countdown
make build

Prebuilt binaries for Linux, macOS, and Windows are also available on the releases page. When you launch it for the first time an events.json file will be created in the user's system-defined config directory:

• Linux: ~/.config/countdown/
• macOS: ~/Library/Application Support/countdown/
• Windows: %APPDATA%\countdown\

On the first startup, just one prepopulated event (Golang's next anniversary) will be shown.

As you add and remove events, the events.json file will be updated.

Usage

The controls are

• "+" to add an event
• "-" to remove an event
• "/" to filter events
• "q" or ctrl+c to quit

The rest of the controls are what you would expect, up/down to traverse the list, tab to move between fields in the event input form.

Development

Common tasks are wrapped in the Makefile:

make test      # run tests with the race detector
make lint      # run golangci-lint
make build     # build the countdown binary
make snapshot  # build a local release snapshot with goreleaser

Releases are published automatically by GoReleaser via GitHub Actions when a v* tag is pushed.