https://github.com/RichardLitt/ignore-github-users

Remove GitHub notifications from specific users
https://github.com/RichardLitt/ignore-github-users

cli github github-enterprise notifications

Last synced: 5 days ago
JSON representation

Remove GitHub notifications from specific users

• Host: GitHub
• URL: https://github.com/RichardLitt/ignore-github-users
• Owner: RichardLitt
• License: mit
• Created: 2016-01-12T21:39:41.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T22:15:52.000Z (almost 2 years ago)
• Last Synced: 2024-11-02T00:42:22.177Z (10 days ago)
• Topics: cli, github, github-enterprise, notifications
• Language: JavaScript
• Homepage:
• Size: 1.36 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 26
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# ignore-github-users

[![Greenkeeper badge](https://badges.greenkeeper.io/RichardLitt/ignore-github-users.svg)](https://greenkeeper.io/)

[![NPM](https://nodei.co/npm/ignore-github-users.png)](https://nodei.co/npm/ignore-github-users/)

[![Build Status](https://travis-ci.org/RichardLitt/ignore-github-users.svg?branch=master)](https://travis-ci.org/RichardLitt/ignore-github-users)

> Remove GitHub notifications from specific users

## Install

```

$ npm install --save ignore-github-users

```

## Usage

```js

const ignoreGithubUsers = require('ignore-github-users');

ignoreGithubUsers('greenkeeper[bot]');

//=> 'Ignored greenkeeperio-bot'

```

## API

### ignoreGithubUsers(input)

#### input

Type: `string`, `array`

The user or users to ignore.

#### token

Type: `token`

Your GitHub personal access token. Can be set as `$GITHUB_TOKEN` in your env.

#### enterprise

Type: `string`

The URL for your GitHub enterprise endpoint.

## CLI

```

$ npm install --global ignore-github-users

```

```

$ ignore-github-users --help

  Usage

    $ ignore-github-users  [opts]

  Options

    -t, --token A token

    -e, --enterprise A different GitHub endpoint

  Examples

    $ ignore-github-users greenkeeper[bot]

    Ignored 3 issues with greenkeeper[bot].

    $ ignore-github-users greenkeeper[bot]

    No notifications from greenkeeper[bot].

```

## Contribute

Please do!

## License

MIT © [Richard Littauer](http://burntfen.com)