All the power of GitHub in your terminal.

• Install
• Usage
• Dependencies
• Demonstration
• Available commands
  • Pull requests
  • Notifications
  • Issues
  • Repo
  • Gists
  • User
  • Alias
• Config
• Plugins
• Tasks
• Team
• Contributing
• History
• License

[sudo] npm install -g gh

gh [command] [payload] [--flags]

In order to sucessfully run this project you must have NodeJS installed.

gh help

• List all comands options.

gh help --all ```

• List specific command options.

gh help ```

gh pull-request

Alias: gh pr

• Shortcut for listing open pull requests for the current repository.

gh pr ```

• List open pulls requests for all branches from all your repositories.

gh pr --list --all ```

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

gh pr --list --me ```

• 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 ```

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

gh pr 1 ```

• Fech pull request rebasing or merging into the current branch.

gh pr 1 --fetch --rebase gh pr 1 --fetch --merge ```

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.

• Merge or rebase pull request into a 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 ```

• Comment on a pull request.

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

• Forward a pull request to another reviewer.

gh pr 1 --fwd username ```

• 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 ```

Omitting --title will submit a pull request using the last commit message as title.

• Submit a pull request using the current branch.

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

• 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 ```

• Open GitHub pull request page in the browser.

gh pr 100 --browser ```

gh notification

Alias: gh nt

• 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 ```

• 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 ```

gh issue

Alias: gh is

• Shortcut for creating a new issue on the current repository.

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

• 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!' --label bug,question,test ```

• Create a new issue and assign it to someone.

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

• Comment on an issue of the current repository.

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

• Comment on an issue of a certain repository.

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

• 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 ```

• 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 filtered by milestone.

gh is --list --milestone 1 ```

• List issues that contains labels todo and bug.

gh is --list --label todo,bug ```

• List all issues on a certain repository.

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

• Open GitHub issue page in the browser.

gh is 100 --browser ```

gh repo

Alias: gh re

• 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 ```

• 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 ```

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

gh re --new foo --clone ```

• 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 ```

• 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 ```

• Delete a repository of the logged user.

gh re --delete foo ```

gh gists

Alias: gh gi

• Shortcut for opening your Gists in the browser.

gh gi ```

• Open a Gist in the browser.

gh gi --browser --id 5991877 ```

• List all gists.

gh gi --list ```

• List all gists from someone.

gh gi --list --user brunocoelho ```

• Create a Gist foo.js pasting the contents of your clipboard.

gh gi --new foo.js --paste ```

• 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 ```

• Fork a Gist.

gh gi --fork 5444883 ```

• Delete a Gist.

gh gi --delete 4252323 ```

• Delete multiple Gists.

gh gi --delete 4252321 --delete 4252322 ```

gh user

Alias: gh us

• Login or show current logged in GitHub user.

gh user --login ```

• Logout current GitHub account.

gh user --logout ```

gh alias

Alias: gh al

• Shortcut for listing aliases.

gh alias ```

• List aliases.

gh alias --list ```

• Create alias for username.

gh alias --add zeno --user zenorocha ```

• Remove alias.

gh alias --remove zeno ```

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).

• GitHub API configurations. Change it if you're a GitHub Enterprise user.

"api": { "host": "api.github.com", "protocol": "https", "version": "3.0.0" } ```

• Set default branch and remote.

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

• GitHub data filled once you log in.

"github_token": "", "github_user": "" ```

• 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-" ```

• Insert signature below issue comment.

"signature": "

Sent from GH." ```

• 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.

• Bump package version, create tag, commit and push.

grunt bump # v0.0.1 grunt bump:minor # v0.1.0 grunt bump:major # v1.0.0 ```

• Run JSBeautifier, a tool to format code.

grunt format ```

• Run JSHint, a tool to detect errors and potential problems.

grunt lint ```

• Run Mocha, a unit test framework.

grunt test ```

• Watch for changes and run lint and test tasks.

grunt watch ```

• Shortcut for jshint and mochaTest tasks.

grunt ```

Node GH is maintained by these guys and some awesome contributors.

Eduardo Lundgren	Zeno Rocha	Henrique Vicente	Bruno Coelho

If you want to fix bugs or add new features you'll need to run in development environment.

1. Remove the installed version from NPM: npm rm -g gh
2. Go to the package folder and create a symlink: npm link

Contribute new commands to this project by copying and editing the content of Hello World example.

Check Release list.

BSD License