<commit_before># g + h = github [![Build Status](https://travis-ci.org/jingweno/gh.png?branch=master)](https://travis-ci.org/jingweno/gh)

![gh](http://owenou.com/gh/images/gangnamtocat.png)

Fast GitHub command line client implemented in Go. Current version is [v0.25.1](https://github.com/jingweno/gh/releases/tag/v0.25.1).

## Overview

gh is a command line client to GitHub. It's designed to run as fast as possible with easy installation across operating systems.
If you like gh, please also take a look at [hub](https://github.com/github/hub). Hub is a reference implementation to gh.

## Motivation

**Fast** 

    $ time hub version > /dev/null
    hub version > /dev/null  0.03s user 0.01s system 93% cpu 0.047 total

    $ time gh version > /dev/null
    gh version > /dev/null  0.01s user 0.01s system 85% cpu 0.022 total

    $ time hub browse > /dev/null
    hub browse > /dev/null  0.07s user 0.04s system 87% cpu 0.130 total

    $ time gh browse > /dev/null
    gh browse > /dev/null  0.03s user 0.02s system 87% cpu 0.059 total

**Muti-platforms**

gh is fully implemented in the Go language and is designed to run across operating systems.

**Easy installation**

There're no pre-requirements to install gh. Download the [binary](https://github.com/jingweno/gh/releases) and go!

## Installation

### Homebrew

Installing on OSX is easiest with [Homebrew](https://github.com/mxcl/homebrew):

    $ brew install https://raw.github.com/jingweno/gh/master/homebrew/gh.rb

### Standalone

`gh` is easily installed as an executable.
Download the [compiled binary forms of gh](https://github.com/jingweno/gh/releases) for Darwin, Linux and Windows.

### Boxen

If you're using [boxen](http://boxen.github.com/), there's a [puppet-gh](https://github.com/boxen/puppet-gh) module to install and set up `gh`.

### Source

To compile gh from source, you need to have a [Go development environment](http://golang.org/doc/install), version 1.1 or better, and run:

    $ go get github.com/jingweno/gh

Note that `go get` will pull down sources from various VCS.
Please make sure you have git and hg installed.

## Upgrade

Since gh is under heavy development, I roll out new releases often.
Please take a look at the [built binaries](https://github.com/jingweno/gh/releases) for the latest built binaries.
I plan to implement automatic upgrade in the future.

### Homebrew

To upgrade gh on OSX with Homebrew, run:

    $ brew upgrade https://raw.github.com/jingweno/gh/master/homebrew/gh.rb

### Source

To upgrade gh from source, run:

    $ go get -u github.com/jingweno/gh

## Aliasing

It's best to use `gh` by aliasing it to `git`.
All git commands will still work with `gh` adding some sugar.

`gh alias` displays instructions for the current shell. With the `-s` flag,
it outputs a script suitable for `eval`.
<commit_msg>Update RAEDME with brew tap<commit_after># g + h = github [![Build Status](https://travis-ci.org/jingweno/gh.png?branch=master)](https://travis-ci.org/jingweno/gh)

![gh](http://owenou.com/gh/images/gangnamtocat.png)

Fast GitHub command line client implemented in Go. Current version is [v0.25.1](https://github.com/jingweno/gh/releases/tag/v0.25.1).

## Overview

gh is a command line client to GitHub. It's designed to run as fast as possible with easy installation across operating systems.
If you like gh, please also take a look at [hub](https://github.com/github/hub). Hub is a reference implementation to gh.

## Motivation

**Fast** 

    $ time hub version > /dev/null
    hub version > /dev/null  0.03s user 0.01s system 93% cpu 0.047 total

    $ time gh version > /dev/null
    gh version > /dev/null  0.01s user 0.01s system 85% cpu 0.022 total

    $ time hub browse > /dev/null
    hub browse > /dev/null  0.07s user 0.04s system 87% cpu 0.130 total

    $ time gh browse > /dev/null
    gh browse > /dev/null  0.03s user 0.02s system 87% cpu 0.059 total

**Muti-platforms**

gh is fully implemented in the Go language and is designed to run across operating systems.

**Easy installation**

There're no pre-requirements to install gh. Download the [binary](https://github.com/jingweno/gh/releases) and go!

## Installation

### Homebrew

The easiest way to install `gh` on OSX is through [Homebrew](https://github.com/mxcl/homebrew).
You can add the [gh Homebrew repository](https://github.com/jingweno/homebrew-gh) with [`brew tap`](https://github.com/mxcl/homebrew/wiki/brew-tap):

    $ brew tap jingweno/gh
    $ brew install gh

### Standalone

`gh` can be easily installed as an executable.
Download the latest [compiled binary forms of gh](https://github.com/jingweno/gh/releases) for Darwin, Linux and Windows.

### Boxen

If you're using [boxen](http://boxen.github.com/), there's a [puppet-gh](https://github.com/boxen/puppet-gh) module to install and set up `gh`.

### Source

To compile gh from source, you need to have a [Go development environment](http://golang.org/doc/install), version 1.1 or better, and run:

    $ go get github.com/jingweno/gh

Note that `go get` will pull down sources from various VCS.
Please make sure you have git and hg installed.

## Upgrade

Since gh is under heavy development, I roll out new releases often.
Please take a look at the [built binaries](https://github.com/jingweno/gh/releases) for the latest built binaries.
I plan to implement automatic upgrade in the future.

### Homebrew

If you installed `gh` with `brew tap jingweno/gh`, you can upgrade it with:

    $ brew upgrade gh

### Source

To upgrade gh from source, run:

    $ go get -u github.com/jingweno/gh

## Aliasing

It's best to use `gh` by aliasing it to `git`.
All git commands will still work with `gh` adding some sugar.

`gh alias` displays instructions for the current shell. With the `-s` flag,
it outputs a script suitable for `eval`.

{'fraction_non_alphanumeric': 0.11455108359133127, 'fraction_numerical': 0.019951840385276916, 'mean_word_length': 3.604117181314331, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 19, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4750914', 'n_tokens_mistral': 2012, 'n_tokens_neox': 1832, 'n_words': 710}