statii

README

statii - a status tool

Statii is a terminal application for displaying notifications from various services. The project arose because I noticed that users (myself included) increasingly disable notifications, due to notification flooding. At the same time, there are specific notifications a user wants, based on their specific needs.

In some cases, notifcations aren't made available for the systems in question - and statii becomes your way to write custom plugins to surface them.

Statii will draw a self-updating table, in the terminal. As of this writing, it updates every 30 seconds, but will properly support async updates in future versions. Clicking on any table row will open the associated notification link, in your browser, and statii will continue to run.

Usage

Configure your statii.conf - as per the example file, and run the application via ./statii

Configuration

Each statii section must contain an identifying name element, in addition to the configuration options for the underlying plugin.

---

Building

Statii requires go version 1.19 or higher and gnu make, though the latter is a wrapper around go build. But, once installed you need to run make.

Testing

The easiest way to test, is go test, but do do so, for all tokens mentioned in os.Getenv calls (i.e the GITHUB_TOKEN) belong in a dotenv file. Create a file at the root of the repository clone - adding all such environment variables.