github.com/tsuyoshiwada/git-prout@v0.0.0-20170402150409-5c51421d4bdb/README.md (about)

     1  # git-prout
     2  
     3  [![Travis](https://img.shields.io/travis/tsuyoshiwada/git-prout.svg?style=flat-square)](https://travis-ci.org/tsuyoshiwada/git-prout)
     4  [![GitHub release](http://img.shields.io/github/release/tsuyoshiwada/git-prout.svg?style=flat-square)](https://github.com/tsuyoshiwada/git-prout/releases)
     5  [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/tsuyoshiwada/git-prout/blob/master/LICENSE)
     6  
     7  > `git-prout` is a CLI tool using Golang. You can easily checkout GitHub Pull Request locally.
     8  
     9  
    10  
    11  ## Table of Contents
    12  
    13  - [Demo](#demo)
    14  - [Install](#install)
    15  - [Usage](#usage)
    16  - [Contribute](#contribute)
    17  - [License](#license)
    18  
    19  
    20  
    21  ## Demo
    22  
    23  ![Demo Animation](./docs/demo.gif)
    24  
    25  
    26  
    27  ## Install
    28  
    29  ### Homebrew
    30  
    31  ```bash
    32  $ brew tap tsuyoshiwada/git-prout
    33  $ brew install git-prout
    34  ```
    35  
    36  If you are in another platform, you can download binary from [release page](todo) and place it in `$PATH` directory.
    37  
    38  ### Golang
    39  
    40  Or you can use `go get`.
    41  
    42  ```bash
    43  $ go get -u github.com/tsuyoshiwada/git-prout
    44  ```
    45  
    46  
    47  
    48  ## Usage
    49  
    50  ```bash
    51  $ git-prout [<options>] <number>
    52  
    53  Options:
    54    -h, --help             Show context-sensitive help (also try --help-long and --help-man).
    55        --version          Show application version.
    56        --debug            Enable debug mode.
    57    -r, --remote="origin"  Reference of remote.
    58    -f, --force            Force execute pull or checkout.
    59    -q, --quiet            Silence any progress and errors (other than parse error).
    60  
    61  Arguments:
    62    <number>  ID number of pull request
    63  
    64  ```
    65  
    66  
    67  ### Tips
    68  
    69  You can execute `git-prout` as a git subcommand.
    70  
    71  ```bash
    72  $ git prout 123
    73  ```
    74  
    75  
    76  
    77  ## Contribute
    78  
    79  1. Fork (https://github.com/tsuyoshiwada/git-prout)
    80  1. Create a feature branch
    81  1. Commit your changes
    82  1. Rebase your local changes against the master branch
    83  1. Run test suite with the `go test` command and confirm that it passes
    84  1. Create new Pull Request :)
    85  
    86  Bugs, feature requests and comments are more than welcome in the [issues](https://github.com/tsuyoshiwada/git-prout/issues).
    87  
    88  
    89  
    90  ## License
    91  
    92  [MIT © tsuyoshiwada](./LICENSE)