gh

Node GH

All the power of GitHub in your terminal.

Table of contents

• Install
• Usage
• Dependencies
• Demonstration
• Config
• Plugins
• Tasks
• Team
• Contributing
• History
• License

Install

[sudo] npm install -g gh

Usage

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

List all comands options

gh help --all

Dependencies

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

Demonstration

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

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

:octocat: Sent from GH." ```

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.

Tasks

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

Team

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

Eduardo Lundgren	Zeno Rocha	Henrique Vicente	Bruno Coelho

Contributing

For detailed instructions, check Contributing.

History

For detailed changelog, check Releases.

License

BSD License