Repository files navigation

GitHub Notifications was created by, and is maintained byThe Dragon Code,and is a simple command line tool to mark all notifications about issues or rejected PRs as read on a givenorganization.

PHP 8.2+ is required. To get the latest version, simply require the project usingComposer:

composer global require dragon-code/github-notifications:*

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

To update global dependencies, use the console command:

composer global update

You'll also need to create yourself apersonal access tokenfor GitHub's API with access to thenotifications scope.

By default, we check several places for the presence of a token in the following order:

1. Thetoken parameter passed when calling the console command
2. TheGITHUB_TOKEN environment variable
3. ~/.composer/auth.json file
4. ~/.config/.composer/auth.json file
5. ~/.config/composer/auth.json file
6. ~/AppData/Roaming/Composer/auth.json file
7. ~/composer/auth.json file
8. %USERPROFILE%/AppData/Roaming/Composer/auth.json file

If the token is not found, you will receive a message about this.

To read all issue notifications:

notificationsread

To clear all issue notifications for the Laravel organization:

notificationsread laravel

Or, if you are specifying a token:

notificationsread laravel --token {...}

In addition, you can use any part of the organization name and/or repository name to check against the template:

notificationsread laravel/framework# ornotificationsread lara*/fra# ornotificationsread framework# ornotificationsread work# ornotificationsread fra*rk

Pattern matching is implemented using theStr::is method.

You can also specify several names:

notificationsread laravel/framework laravel/jet

When determining the name, thestr_starts_with function isused.

By default, only those Issues and Pull Requests that have been closed or merged are marked as read.

But you can define the parameters yourself:

-r, --except-repository  Exclude repositories from processing-i, --except-issues      Exclude issues from processing-p, --except-pulls       Exclude Pull Requests from processing-m, --except-mentions    Exclude notifications with your mention from processing-o, --with-open          Process including open Issues and Pull Requests-n, --no-interaction     Do not ask any interactive question-q, --quiet              Do not output any message

For example:

# except issues + with opennotificationsread laravel -ion

With this set of options, notifications that have:

• whose repository name begins with the wordlaravel
• Pull Requests only, both open and closed
• will not be asked to continue in the console

You can call the console command to display help information:

notificationsread --help

You can also exclude certain repositories:

notificationsread laravel -ion -r laravel/framework -r laravel/breeze

With this set of options, notifications that have:

• whose repository name begins with the wordlaravel
• Pull Requests only, both open and closed
• will not be asked to continue in the console
• repositorieslaravel/framework andlaravel/breeze will not be processed

Execute a console command with the following parameters:

notificationsread -n --except-mentions

Execute a console command with the following parameters:

notificationsread -n --except-mentions --with-open

❤️ The Dragon Code? Please consider supporting our collective onBoosty.

This package is licensed under theMIT License.