node-gh-fork v1.12.11

Node GH

All the power of GitHub in your terminal.

Table of contents

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

Install

[sudo] npm install -g gh

Usage

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

Dependencies

In order to sucessfully run this project you must have NodeJS >= v0.12.0 installed.

Demonstration

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

1. Info

2. List

Examples

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

gh pr

• Get information about a pull request.

gh pr --info number

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

3. Fetch

Examples

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

gh pr 1

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

gh pr 1 --fetch --rebase

gh pr 1 --fetch --merge

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

• 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

5. Comment

Examples

• Comment on a pull request.

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

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

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

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

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

9. Open in Browser

Examples

• Open GitHub pull request page in the browser.

gh pr 100 --browser

Notifications

gh notification

Alias: gh nt

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

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

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

2. Comment

Examples

• 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

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

4. List

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

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

6. 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'

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

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

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

3. Create

Examples

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

gh re --new foo --clone

• 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

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

5. Delete

Example

• Delete a repository of the logged user.

gh re --delete foo

6. Clone

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

7. Create Label

Examples

• Create a label for a repository.

gh re --label --new bug --color color --repo gh

• Create a label for a user's repository.

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

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

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

10. Update Label

Examples

• Update a label for a repository.

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

Gists

gh gists

Alias: gh gi

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

2. List

Examples

• List all gists.

gh gi --list

• List all gists from someone.

gh gi --list --user brunocoelho

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

4. Fork

Examples

• Fork a Gist.

gh gi --fork 5444883

5. Delete

Example

• Delete a Gist.

gh gi --delete 4252323

• Delete multiple Gists.

gh gi --delete 4252321 --delete 4252322

User

gh user

Alias: gh us

1. Login/Logout

Examples

• Login or show current logged in GitHub user.

gh user --login

• Logout current GitHub account.

gh user --logout

2. Whoami

Examples

• Prints your username to stdout.

gh user --whoami

Alias

gh alias

Alias: gh al

1. List

Examples

• Shortcut for listing aliases.

gh alias

• List aliases.

gh alias --list

2. Add

Examples

• Create alias for username.

gh alias --add zeno --user zenorocha

3. 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": "api.github.com",
    "protocol": "https",
    "version": "3.0.0",
    "pathPrefix": null
}

• Set default branch and remote.

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

• Set default users when submitting or forwarding pull requests.

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

• 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": "<br><br>:octocat: *Sent from [GH](http://nodegh.io).*"

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.

Developer Tasks

• complexity Show code complexity analysis summary
• plato Create advanced code complexity static analysis in HTML
• unit Run unit tests and create code coverage report in HTML
• test Run all code quality tools
• coverage-report Open code coverage report
• plato-report Open code complexity and static analysis report

Team

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

Contributors
Eduardo Lundgren	Zeno Rocha	Henrique Vicente
Bruno Coelho	Dustin Ryerson

Contributing

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

Optional Plugins to install for your code editor:

Prettier (formatter primarily for JS files)

Prettier is an opinionated code formatter. https://prettier.io/playground/

• User Guide: https://github.com/prettier/prettier
• VS Code Editor Plugin: https://github.com/prettier/prettier-vscode
• Vim Plugin: https://github.com/prettier/vim-prettier
• Sublime: https://packagecontrol.io/packages/JsPrettier

ESlint (linter)

ESlint is a pluggable linting utility for JavaScript

• User Guide: https://eslint.org/docs/user-guide/getting-started#configuration
• VS Code Editor Plugin: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
• Vim Plugin: https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript
• Sublime: https://github.com/roadhump/SublimeLinter-eslint

History

For detailed changelog, check Releases.

License

BSD License