jacek-rzrz/ghostie

Github notifications in your terminal

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.

ghostie
manage your github notifications in terminal

USAGE:
    ghostie <SUBCOMMAND>

SUBCOMMANDS:
    clear-logs    Clear logs from the background process
    count -C      Query the count of unread github notifications
    logs -L       Show logs from the background process
    prune -P      Prune all notifications from the local cache
    start         Run ghostie as a background process
    stop          Stop ghostie as a background process
    view -V       Open UI to manage github notifications