DEPRECATED

Node GH

Boost your productivity & automate tasks when working with GitHub, all from the comfort of your CLI.

Table of contents

Contributors

Install

npm install -g gh

Usage

• Most commands require you to use a developer key
• We automate the process for you the first time you run a command
• Instructions on manually adding a developer key for extra security

Simple example: list prs for current repo

gh pr

Contributors

Huge thanks goes to these wonderful people (emoji key):

Eduardo Lundgren 💻 🐛 📖 💬 🚇 🔌 ⚠️ 👀 🤔	Zeno Rocha 💻 🐛 📖 💬 🚇 🔌 ⚠️ 👀 🤔 🖋	Henrique Vicente 💻 🐛 💬 🚇 🔌 ⚠️ 👀 🛡️ 🤔	Ryan Garant 🐛 💬 🚇 🔌 ⚠️ 👀 🛡️ 🤔	Bruno Coelho 💻 🐛	Dustin Ryerson 💻	Drew Brokke 💻 🤔
Jose Ignacio 💻	Rodrigo Vidal 💻	Hamza Baig 💻	Gregory Amerson 💻 🐛	Tom Rochette 💻 🐛 🚇	Mike Roberts 💻	Snyk bot 💻
BlockchainDeveloper 💻	João Paulo Bochi 💻	Matthew Elphick 💻	Nate Cavanaugh 💻	Peter Dave Hello 💻	Matt DesLauriers 💻	oughter 💻
Adrian Macneil 💻	Aleksey Ostapenko 💻	Aliaksei 💻	Andrey 💻	André de Oliveira 💻	Brandon Patram 💻	Chema Balsas 💻
Christian Schlensker 💻	Ciro Nunes 💻	Denis Efremov 💻	Henri Cavalcante 💻	Jaka Hudoklin 💻	José F. Romaniello 💻	Joshua Wu 💻
Kevon Eaglin 💻	M. Tarık Yurt 💻	Marcus Buffett 💻	Randѕon 💻	Alex Hall 💻	Rossi Oddet 💻	Ryan Schmukler 💻
Stephen Williams 💻	Trevor Bortins 💻	Whitney Young 💻	Xavier RENE-CORAIL 💻	YAMAMOTO Yuji 💻	Sam Mikes 💻	Tiju Thomas 💻
Zev Averbach 💻 🐛	Aaron Jones 🐛	Ryan Schumacher 🐛	Rob Dodson 🐛	Derek Sifford 🐛	rachidbch 🐛	Liraz Siri 🐛
Zsolt Balogh 🐛 📖	Iliyan Peychev 🐛	Dante Wang 🐛	Raymond Augé 🐛	Mohamed Bassem 🐛	Rich Sezov 🐛	Jason Kuhrt 🐛
gon138 🐛	Maxim Novikov 🐛	Anders D. Johnson 🐛	Gabriel Izaias 🐛	Myles McNamara 🐛	Gilad Peleg 🐛	Yoshua Wuyts 🐛
Marc Lundgren 🐛	Julio Camarero 🐛	Marcellus Tavares 🐛	Sergio Gonzalez 🐛	Djalma Araújo 🐛	Bruno Basto 🐛	Jason Pincin 🐛
Joel Kuzmarski 🐛	Nadeem Bitar 📖	Cleydyr Bezerra de Albuquerque 🐛	Ramon Pires da Silva 🔌	Patrick Weingärtner 💻	Gabriel Ramos 💻	Manuel de la Peña 💻
Jose M Vidal 🐛	Saulo Vallory 💻	Hernan Fernandez 💻	Aaron Berry 💻	Inácio Nery 🐛 💻	Marcus Bizal 🐛	Julien Castelain 🐛 💻
Andrew Bradley 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

Contributing

For detailed instructions, check Contributing. Don't miss the source code reports.

History

For detailed changelog, check Releases.

License

BSD-3-Clause

Demonstration

Supported Node Versions:

We support the node versions that the Node.js organization supports which as of now is Node v6 & up.

Authentication

Under the hood, we are using @octokit/rest to work with the GitHub API The method of authentication that we use with octokit, is a personal access token You have two options here: 1. Run gh which will start the authentication process & generate the token for you automatically - Though they are hidden, the downside of this is having to type your user & pass - Supports 2fa 2. Manually generate your personal token & add it to your ~/.gh.json

Available commands

gh help

List all comands options.

gh help --all

List specific command options.

gh help <command>

Global flags

The verbose flag is useful for debugging issues. The insane flag is a more complete verbose flag, which leaks more privacy sensitive data by default.

Pull requests

gh pull-request

Alias: gh pr

PR: Info

Get information about a pull request.

gh pr --info 1

PR: List

• user is owner of the repository, it is the authenticated user by default.
• remote is the name of the remote configuration in a git directory, i.e. origin, upstream.
• Therefore, it only makes sense when this command is run in a git directory.
• To turn off pretty printing of output in a table add "pretty_print": false to your ~/.gh-json config
• To adjust pagination rules

Examples

Shortcut for listing open pull requests for the current repository

gh pr

List open pull requests for all branches from all your repositories.

gh pr --list --all

List open pull requests for all branches in all repositories belonging to the "github" organization.

gh pr --list --all --org github

List open pull requests sent by logged user on current repository.

gh pr --list --me

List open pull requests in node-gh/gh repository.

gh pr --list --user node-gh --repo gh

List open pull requests with link and content.

gh pr --list --detailed

List open pull requests for a branch.

gh pr --list --branch master

List open pull requests and sort them by popularity (comment count).

gh pr --list --sort popularity

List open pull requests and sort them by asc long-running (old but still active).

gh pr --list --sort long-running --direction asc

List open pull requests and sort them by complexity (complexity is calculated based on number of additions, deletions, changed files, comments and review comments).

gh pr --list --sort complexity

List open pull requests with their link

gh pr --list --link

List open pull requests with a formatted date (Any string that the moment library's formatter accepts should work: https://momentjs.com/docs/#/displaying/format/).

gh pr --list --date "dddd, MMMM Do YYYY, h:mm:ss a"

PR: Merge or Rebase

Omitting --number will try to guess the pull number from branch name e.g. pr-1 results in --number 1. Omitting --branch will merge or rebase into config.default_branch.

Examples

Shortcut for fetching pull request and checkout into a new branch pr-1.

gh pr 1

Merge or rebase pull request into a local branch.

gh pr 1 --fetch --merge

gh pr 1 --fetch --rebase

Merge or rebase pull request into branch dev.

gh pr 1 --fetch --rebase --branch dev

gh pr 1 --fetch --merge --branch dev

PR: Comment

Examples

Comment on a pull request.

gh pr 1 --comment "Merged, thank you!"

Submit a pull request using your default editor by passing an empty --comment

gh pr 1 --comment

PR Forward

Omitting a value for --fwd fallbacks to the default_pr_forwarder key found in your config file.

Examples

Forward a pull request to another reviewer.

gh pr 1 --fwd username

PR: Open or Close

Examples

Open a pull request.

gh pr 1 --open

Close a pull request.

gh pr 1 --close

Close multiple pull requests.

gh pr --close --number 1 --number 2

Open multiple pull requests.

gh pr --open --number 1 --number 2

Open or close a pull request that you've sent to someone.

gh pr 1 --close --user eduardolundgren

PR: Submit

Omitting a value for --submit fallbacks to the default_pr_reviewer key found in your config file. Omitting --title will submit a pull request using the last commit message as title.

Examples

Submit a pull request using the current branch to the repository owner or organization.

gh pr --submit eduardolundgren --title 'Fix #32' --description 'Awesome fix'

Submit a pull request using your default editor by passing an empty --title and or --description

gh pr --submit eduardolundgren --title --description

Submit a pull request using the current branch to dev branch.

gh pr --submit eduardolundgren --branch dev

Submit a pull request from a issue.

gh pr --submit eduardolundgren --issue 150

Submit a pull request in draft state.

gh pr --submit eduardolundgren --draft

PR: Open in Browser

Examples

Open GitHub pull request page in the browser.

gh pr 100 --browser

Notifications

gh notification

Alias: gh nt

Notifications: Latest

Examples

Shortcut for displaying the latest activities on the current repository.

gh nt

Display the latest activities on a certain repository.

gh nt --latest --user eduardolundgren --repo node-gh

Diplay notifications with a formatted date (Any string that the moment library's formatter accepts should work: https://momentjs.com/docs/#/displaying/format/).

gh nt --date "dddd, MMMM Do YYYY, h:mm:ss a"

Notifications: Watch

Examples

Watch for any activity on the current repository.

gh nt --watch

Watch for any activity on a certain repository.

gh nt --watch --user eduardolundgren --repo node-gh

Issues

gh issue

Alias: gh is

Issue: Create

Examples

Shortcut for creating a new issue on the current repository.

gh is 'Node GH rocks!' 'Body with **Markdown** support'

Create a new issue using your default editor by passing an empty --message (also works with an empty title)

gh is --new --title 'Node GH rocks!' --message

Create a new issue on a certain repository.

gh is --new --title 'Node GH rocks!' --message 'Body with **Markdown** support' --user eduardolundgren --repo node-gh

Create a new issue with labels.

gh is --new --title 'Node GH rocks!' --labels bug,question,test

Create a new issue and assign it to someone.

gh is --new --title 'Node GH rocks!' --assignee zenorocha

Issue: Comment

Examples

Comment on an issue of the current repository.

gh is 1 --comment 'Node GH rocks!'

Comment on an issue using your default editor by passing an empty --comment (also works with an empty title)

gh is 1 --comment

Comment on an issue of a certain repository.

gh is 1 --comment 'Node GH rocks!' --user eduardolundgren --repo node-gh

Issue: Open or Close

Examples

Open an issue.

gh is 1 --open

Close an issue.

gh is 1 --close

Close multiple issues.

gh is --close --number 1 --number 2

Open multiple issues.

gh is --open --number 1 --number 2

Open or close an issue that you've sent to someone.

gh is 1 --close --user eduardolundgren

Issue: List

• To adjust pagination rules

Examples

Shortcut for listing all issues on the current repository.

gh is

List all issues from all repositories.

gh is --list --all

List issues assigned to someone.

gh is --list --assignee zenorocha

List issues with link and content.

gh is --list --detailed

List only closed issues on the current repository.

gh is --list --state closed

List issues with a formatted date (Any string that the moment library's formatter accepts should work: https://momentjs.com/docs/#/displaying/format/).

gh is --list --date "dddd, MMMM Do YYYY, h:mm:ss a"

List issues filtered by milestone title.

gh is --list --milestone "milestone title"

List issues that contains labels todo and bug.

gh is --list --labels todo,bug

List all issues on a certain repository.

gh is --list --user eduardolundgren --repo node-gh

Issue: Open in Browser

Examples

Shortcut for opening GitHub issue page in the browser.

gh is 100

Open GitHub issue page in the browser.

gh is 100 --browser

Issue: Lock

Examples

Lock issue on the current repository.

gh is 1 --lock

Lock issue on the current repository with a reason.

gh is 1 --lock --lock-reason resolved

Issue: Search

Examples

Search issues in current repository

gh is --search 'term'

Search issues in all repositories for a user

gh is --all --user node-gh --search 'term'

Search issues in a repository for a user

gh is  --user node-gh --repo gh --search 'term'

Search issues in a repository for a user with link and content

gh is  --user node-gh --repo gh --search 'term'

Search issues with github filters

gh is  --user node-gh --repo gh --search 'updated:<=2013-05-24'

Issue: Assign

Examples

Assign an issue on the current repository to a user.

gh is --assign --assignee zenorocha --number 1

Assign an issue on a specific repository to a user.

gh is --assign --assignee zenorocha --number 1 --user eduardolundgren --repo gh

Repo

gh repo

Alias: gh re

Repo: Open in Browser

Examples

Shortcut for opening the GitHub repository page in the browser.

gh re

Open GitHub repository page in the browser.

gh re --browser --user eduardolundgren --repo node-gh

Repo: List

Examples

List all repositories.

gh re --list

List all private repositories.

gh re --list --type private

List all repositories from someone.

gh re --list --user zenorocha

List open repositories with a formatted date (Any string that the moment library's formatter accepts should work: https://momentjs.com/docs/#/displaying/format/).

gh re --list --detailed --date "dddd, MMMM Do YYYY, h:mm:ss a"

Repo: Create

Examples

Create a new GitHub repository and clone on the current directory.

gh re --new foo --clone

Create a new GitHub repository based on the name of the current directory & init with a README

gh re --new --clone --init

Create a new GitHub repository for an organization.

gh re --new foo --organization node-gh

Create a new GitHub repository using .gitignore template for Ruby.

gh re --new gemified --gitignore Ruby

Create a new private repository on GitHub, initializing it with a initial commit of the README.

gh re --new foo --init --type private

Repo: Fork

Examples

Fork a GitHub repository.

gh re --fork repo --user user

Fork a GitHub repository into the node-gh organization.

gh re --fork repo --user user --organization node-gh

Repo: Delete

Example

Delete a repository of the logged user.

gh re --delete foo

Repo: Clone

If you have custom ssh config, you can add "api": { "ssh_host": "custom-name", ... } to your .gh.json file.

Examples

Clone a repository.

gh re --clone --repo gh

Clone a repository from a specific user using HTTPS protocol.

gh re --clone --user eduardolundgren --repo gh --protocol https

Repo: Create Label

Examples

Create a label for a repository (color is a hex code with or without literal hex symbol).

gh re --label --new bug --color '#7057ff' --repo gh

Create a label for a user's repository.

gh re --label --new bug --color '#7057ff' --user eduardolundgren --repo gh

Repo: Delete Label

Examples

Delete a label from a repository.

gh re --label --delete bug --repo gh

Delete a label from a user's repository.

gh re --label --delete bug --user eduardolundgren --repo gh

Repo: List Labels

Examples

List labels for a repository.

gh re --label --list --repo gh

List labels for a user's repository.

gh re --label --list --user eduardolundgren --repo gh

Repo: Update Label

Examples

Update a label for a repository (color is a hex code with or without literal hex symbol).

gh re --label --update bug --color color --repo gh

Update a label for a user's repository.

gh re --label --update bug --color color --user eduardolundgren --repo gh

Repo: Search

Find repositories via various criteria. Repository search looks through the projects you have access to on GitHub. You can filter the results using GitHub's search qualifiers. Examples:

Examples

Search private repositories you have access to with the term "secret".

gh re --search secret --type private

OR

gh re --search secret is:private

Matches repositories from GitHub org showing detailed results.

gh re --detailed -o github --search octocat

OR

gh re --detailed --search octocat org:github

Gists

gh gists

Alias: gh gi

Gist: Open in Browser

Examples

Shortcut for opening your Gists in the browser.

gh gi

Open a Gist in the browser.

gh gi --browser --id 5991877

Gist: List

Examples

List all gists.

gh gi --list

List all gists from someone.

gh gi --list --user brunocoelho

List gists with a formatted date (Any string that the moment library's formatter accepts should work: https://momentjs.com/docs/#/displaying/format/).

gh gi --list --date "dddd, MMMM Do YYYY, h:mm:ss a"

Gist: Create

Examples

Create a Gist hello containing "Hello World".

gh gi --new hello --content "Hello World!"

Create a private Gist hello containing "Hello World".

gh gi --new hello --content "Hello World!" --private

Gist: Fork

Examples

Fork a Gist.

gh gi --fork 5444883

Gist: Delete

Example

Delete a Gist.

gh gi --delete 4252323

Delete multiple Gists.

gh gi --delete 4252321 --delete 4252322

User

gh user

Alias: gh us

User: Login or Logout

Examples

Automates saving user name & generating developer token credentials to your ~/.gh.json config

• This is the the user that will be used if you do not manually pass in --user username
• After you are logged in, you should no longer be prompted to go through the login process again
• Alternatively you can create your own developer key and copy and paste it
  • First add a file in your home directory called ~/.gh.json
  • You can use the default.gh.json file in our repo as a template
  • Create a developer key: with these scopes: ['user', 'public_repo', 'repo', 'repo:status', 'delete_repo', 'gist']
  • Then copy & paste your token in the file at: "github_token"
  • Write your user name at "github_user"

gh user --login

Automates removing user name & developer token credentials to your ~/.gh.json config

gh user --logout

User: Whoami

Examples

Prints the user name from ~/.gh.json to your console.

gh user --whoami

Milestones

gh milestone

Alias: gh ms

Milestone: List

Examples

Shortcut for listing milestones for a specific repo.

gh ms

Listing milestones for a specific repo & user.

gh ms --list --user node-gh --repo gh

Listing all milestones for a specific organization.

gh ms --list --all --organization node-gh

Alias

This cmd provides something similar to shell aliases. If there are aliases in your .gh.json file, we will attempt to resolve the user, PR forwarder or PR submitter to your alias.

gh alias

Alias: gh al

Alias: List

Examples

Shortcut for listing aliases.

gh alias

List aliases.

gh alias --list

Alias: Add

Examples

Create alias for username.

gh alias --add zeno --user zenorocha

And use like:

gh pr --submit zeno -b master -t Title

Alias: Remove

Examples

Remove alias.

gh alias --remove zeno

Config

There are some pretty useful configurations that you can set on .gh.json. This file can be found under home directory (on MacOSx: /Users/yourName/.gh.json on Windows: C:\\Users\yourName\.gh.json).

You can also set per-project configurations by adding a .gh.json file in your project's root folder and overriding existing keys.

GitHub API configurations.

Change it if you're a GitHub Enterprise user.

"api": {
    "host": "github.mydomain.com",
    "protocol": "https"
}

Set Pagination Rules

• For list based commands (like listing prs, issues, or repos) we default to 30
• That means if you ran gh pr you would see a max of 30 pull requests
• If you would like to see more, we will prompt you in your terminal to see the next batch
• You can set your page size up from 1 to 100

"page_size": 77

• If you want to remove the limit & set it to the maximum, use an empty string

"page_size": ""

Set default branch and remote.

"default_branch": "master",
"default_remote": "origin"

Set default users

For submitting or forwarding pull requests.

"default_pr_forwarder": "",
"default_pr_reviewer": ""

Update GitHub credentials manually

"github_token": "your_dev_token",
"github_user": "username"

Run automated tasks before or after a certain command.

"hooks": {
        "pull-request": {
            "merge": {
                "before": [{"cmd": "ls -la", "log": true}],
                "after": [
                    "gh pr {{options.number}} --comment 'Thank you, pull request merged :D'"
                ]
            }
        }
}

Run automated tasks passing arguments to the commands.

Required for prompt commands.

"hooks": {
        "pull-request": {
            "merge": {
                "before": [{"cmd": "foo", "args": ["bar", "qux"]}]
            }
        }
}

Set default branch name prefix for PR fetching.

"pull_branch_name_prefix": "pr-"

Set default editor to use when creating a new message

• For certain tasks like opening a pull request when you omit the title or description, we will open a new file for you to create the message in.
• We first check enviroment variables for the default editor: $EDITOR or $VISUAL and fallback to the default git editor git config --global core.editor
• To disable this functionality of opening your editor add "use_editor": false to ~/.gh.json

Insert signature below issue comment.

"signature": "<br><br>:octocat: *Sent from [GH](http://nodegh.io).*"

Turn off ssh when pulling a repo and use https instead.

"ssh": false,

If you need to use a custom git command, set the environment variable GH_GIT_COMMAND.

Plugins

GH Gif - A plugin for commenting on pull requests/issues using GIF reactions. GH Travis - A plugin for integrating Travis, a continous integration server. GH Jira - A plugin for integrating Jira, an issue management system.

Feel free to create your own plugins by forking GH Boilerplate.