https://github.com/kyanny/ghn

List/Open unread GitHub Notifications.
https://github.com/kyanny/ghn

Last synced: 16 days ago
JSON representation

List/Open unread GitHub Notifications.

• Host: GitHub
• URL: https://github.com/kyanny/ghn
• Owner: kyanny
• License: mit
• Created: 2013-10-25T10:04:20.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2016-06-10T15:04:01.000Z (over 8 years ago)
• Last Synced: 2024-08-31T16:37:46.591Z (2 months ago)
• Language: Ruby
• Homepage: http://kyanny.github.io/ghn/
• Size: 646 KB
• Stars: 50
• Watchers: 5
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Ghn

[![Build Status](https://travis-ci.org/kyanny/ghn.png?branch=master)](https://travis-ci.org/kyanny/ghn)

List/Open unread GitHub Notifications.

## Installation

```

$ gem install ghn

```

## Usage

```

$ ghn help

Commands:

  ghn help [COMMAND]  # Describe available commands or one specific command

  ghn list NAME       # List unread notifications

  ghn open NAME       # Open unread notifications in browser

Options:

  -a, [--all], [--no-all]                                  # List/Open all unread notifications

  -p, [--participating], [--no-participating]              # List/Open notifications your are participating

      [--follow-issuecomment], [--no-follow-issuecomment]  # Follow issuecomment anchor URL

  -s, [--sort], [--no-sort]                                # Sort notifications by url

```

NAME should be a username/reponame of repository.

`$ ghn list` displays first 50 unread notifications to STDOUT.

`$ ghn open rails/rails` opens first 50 unread notifications of rails/rails in your browser.

`$ ghn open -a` opens all unread notifications in your browser.

`$ ghn open -p` opens notifications your are participating only.

`$ ghn open -s` opens notifications sorted by url.

## Aliases

You can set aliases as a shortcut of NAME.

Aliases should be stored to your global `.gitconfig` file.

`$ git config --global ghn.alias.play playframework/playframework`

Now `$ ghn open play` opens unread notifications of playframework/playframework in your browser.

NOTE: aliases must have **ghn.alias** namespace.

## Authentication

Please set **ghn.token** to your `.gitconfig`.

    $ git config --global ghn.token [Your GitHub access token]

You can also set access token via `GHN_ACCESS_TOKEN` environment variable.

## Follow issuecomment anchor

If you provide `--follow-issuecomment` option, or set git config `ghn.followissuecomment` to "yes", "on" or "true",

ghn follows #issuecomment- anchor URL as like GitHub's official notification link.

    $ ghn open --follow-issuecomment

    $ git config --global ghn.followissuecomment true

Commandline option overrides git config setting as well.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request