Gish

Github Issues on the command-line. Not much else to say about it. Runs on OSX/*nix, any Windows compatibility is purely coincidental.

Any questions? Join the conversation at Gitter

Installation

  $ gem install gish

When you first use Gish you will be prompted for your github credentials, and asked if you would like to use Gish with private repositories. This information is used to create a personal access token for your Github account, this token will then be stored and used instead of your credentials.

You may also want to consider setting the environment variables GISH_EDITOR and GISH_BROWSER. These will be used to launch an editor or browser respectively when the need arises. When they are not set, Gish defaults to EDITOR and BROWSER, and finally vi and open.

Why 'open'? Because I'm an OSX user and there's no *nix analogue as far as I can tell.

Usage

Gish has too many commands, subcommands and options to list here, thankfully it's uses the excellent thor under the hood so you can use the help command like so to see your options...

  $ gish help
  $ gish subcommand help

Some commands may allow for excessive input, namely opening and commenting on issues. In these cases, if you don't specify a message with "-m", Gish will spawn an editor for you to write the message in.

Oh, one more thing! Gish expects you to be running against the repository under the origin remote, if you want to override this, use -r/--repository, like so:

  $ gish list -r andrew/24pullrequests

Examples

Here are some examples to get you started.

command outcome
gish list List 20 issues (default count)
gish show 1 Show issue #1
gish show 1 -i Show issue #1 and include comments
gish comment 1 -m ":+1" Comment on issue #1
gish comment 1 Comment on issue #1 using an editor
gish close 1 Close issue #1
gish label 1 such-feature Add the label such-feature to issue #1

When listing issues, the number of comments on an issue will be displayed at the end of a line, along with a tag indicating if the issue is a pull request.

#9 barisbalic           Emoji!                                                            [PR] 2 comments
#8 barisbalic           Fix editor input for open command                                      0 comments
#7 barisbalic           Support API paging                                                     0 comments
#6 barisbalic           Current repository check is lame                                       1 comments
#5 barisbalic           Format issue and comment times                                         0 comments
#4 barisbalic           Enhance terminal output                                                0 comments
#2 barisbalic           Check issue assignee                                                   0 comments
#1 barisbalic           Add config subcommand                                                  0 comments

Contributing

Contributions are very welcome, whether it's refactoring or taking care of the issues.

  1. Fork the repo.
  2. Create your branch git checkout -b branch-name bonus for feature branches
  3. Make your changes
  4. Test to make sure you have not broken any existing functionality
  5. Commit your changes
  6. Push to your branch
  7. Submit a pull request

We will do our best to merge your PR or provide feedback as soon as possible!