README

GitHub Notifications was created by, and is maintained by Graham Campbell, and is a simple command line tool to mark all notifications about issues or rejected PRs as read on a given organization. Feel free to check out the releases, security policy, license, code of conduct, and contribution guidelines.

Installation

PHP 7.4-8.3 is required. To get the latest version, simply require the project using Composer:

$ composer global require "graham-campbell/github-notifications:^4.1"

Alternatively, you can simply clone the repo and run composer install in the folder.

Authentication

You'll also need to create yourself a personal access token for GitHub's API with access to the notifications scope.

Usage

By default, we'll try and read your personal access token for GitHub from the GITHUB_TOKEN environment variable, however you can also specify a token with the --token command-line flag.

To clear all issue notifications for the Laravel organization:

$ notifications clear laravel

Or, if you are specifying a token:

$ notifications clear laravel --token {...}

Building

The following documentation is for contributors to this package only.

To build the phar file, run:

$ make composer-install
$ make box-compiler

Security

If you discover a security vulnerability within this package, please send an email to security@tidelift.com. All security vulnerabilities will be promptly addressed. You may view our full security policy here.

License

GitHub Notifications is licensed under The MIT License (MIT).

graham-campbell / github-notifications

Maintainers

Details