/ghostie

Github notifications in your terminal

Primary LanguageRustMIT LicenseMIT

ghostie

Github notifications in your terminal. Available on MacOS and Linux.

Features

  • Runs as background process, fetching new github notifications in a 48h rolling window.
  • Polls every 1 minute and uses SQLite to persist local cache of notifications.
  • Issues desktop notification when new notifications are received.
  • View notifications in your terminal and opens them in your default browser when selected.

Installation

Homebrew (OS X or Linux)

  1. Install the tap
brew tap attriaayush/ghostie
  1. Install ghostie
brew install ghostie

Uninstalling with Homebrew

  1. Uninstall ghostie
brew uninstall ghostie
  1. Uninstall the tap
brew untap attriaayush/ghostie

Install manually from Release

  1. Download the latest release for your platform
  2. Install to a location in your $PATH

Install manually from source

  1. Ensure Rust is installed
  2. Clone this repo and run cd ghostie
  3. Run cargo install --path .
  4. Ensure ~/.cargo/bin is in your $PATH

Usage

  • Create a Github PAT with notifications as permission.
  • Simply run ghostie and see the list of things that Ghostie supports

Note: To view the notifications using ghostie view ensure ghostie is running as a background process.

Overriding default configuration

  • Simply run ghostie configure and edit the default configuration
  • Restart the background process by running ghostie stop && ghostie start