github-notifier

Crates.iogithub-notifier
lib.rsgithub-notifier
version1.0.0
created_at2025-08-19 18:44:44.058397+00
updated_at2025-08-19 18:44:44.058397+00
descriptionA CLI tool to notify github of new commits
homepagehttps://github.com/whutchinson98/github-notifier
repositoryhttps://github.com/whutchinson98/github-notifier
max_upload_size
id1802300
size48,865
Will Hutchinson (whutchinson98)

documentation

README

Github Notifier

Setup

cargo install github-notifier

Configuration

Create a config.toml file in your home directory under ~/.config/github-notifier/config.toml

github_username = "your-github-username"
github_token = "your-github-token"

Usage

If the exit code is 2, then you have notifications. If the exit code is 0, then you do not have notifications. If the exit code is 1, then there was an error.

Example

Here is an example shell script I use as part of my waybar:

#!/bin/sh

github-notifier
exit_code=$?

if [ $exit_code -eq 2 ]; then
    echo '{"text": "", "class": "notification", "tooltip": "You have GitHub notifications"}'
else
    echo '{"text": "", "class": "none", "tooltip": "No notifications"}'
fi

Debugging

To run with tracing, run RUST_LOG=trace github-notifier

Commit count: 8

cargo fmt