node-gh
All the power of GitHub in your terminal.
Usage
gh [command] [--flags]
Install
[sudo] npm install -g gh
Dependencies
In order to sucessfully run this project you must have NodeJS installed.
Available commands
gh help
Pull requests
1. List
Option | Usage | Type |
---|
-l , --list | Required | Boolean |
-a , --all | Optional | Boolean |
-b , --branch | Optional | String |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh pr --list
```
gh pr --list --all
```
gh pr --list --branch master
```
2. Fetch
Option | Usage | Type |
---|
-f , --fetch | Required | Boolean |
-n , --number | Required | Number |
-M , --merge | Optional | Boolean |
-R , --rebase | Optional | Boolean |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh pr --number 1 --fetch
```
gh pr --number 1 --fetch --rebase
gh pr --number 1 --fetch --merge
```
3. Merge or rebase
Option | Usage | Type |
---|
-M , --merge | Required | Boolean |
-R , --rebase | Required | Boolean |
-n , --number | Optional | Number |
-b , --branch | Optional | String |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Omitting --number
will try to guess the pull number from branch name e.g. pull-1
results in --number 1
. Omitting --branch
will merge or rebase into config.default_branch
.
Examples
gh pr --merge [--number 1] [--branch master]
```
```
gh pr --rebase [--number 1] [--branch master]
```
Option | Usage | Type |
---|
-c , --comment | Required | String |
-n , --number | Required | Number |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh pr --number 1 --comment "Merged, thank you!"
```
5. Forward
Option | Usage | Type |
---|
--fwd | Required | String |
-n , --number | Required | Number |
Examples
gh pr --number 1 --fwd username
```
6. Open or close
Option | Usage | Type |
---|
-o , --open | Required | Boolean |
-C , --close | Required | Boolean |
-n , --number | Required | Number |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh pr --number 1 --open
```
gh pr --number 1 --close
```
gh pr --number 1 --close --user eduardolundgren
```
7. Submit
Option | Usage | Type |
---|
-s , --submit | Required | String |
-b , --branch | Optional | String |
-t , --title | Optional | String |
Omitting --title
will submit a pull request using current branch name as title.
Examples
gh pr --submit eduardolundgren --title 'Fix #32'
```
gh pr --submit eduardolundgren --branch dev
```
Notifications
1. Latest
Option | Usage | Type |
---|
-l , --latest | Required | Boolean |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh nt --latest
```
gh nt --latest --user eduardolundgren --repo node-gh
```
2. Watch
Option | Usage | Type |
---|
-w , --watch | Required | Boolean |
-r , --repo | Optional | String |
-s , --user | Optional | String |
Examples
gh nt --watch
```
gh nt --watch --user eduardolundgren --repo node-gh
```
Issues
1. Create
Option | Usage | Type |
---|
-N , --new | Required | Boolean |
-t , --title | Required | String |
-L , --label | Optional | String |
-m , --message | Optional | String |
-r , --repo | Optional | String |
-u , --user | Optional | String |
Examples
gh is --new --title 'Node GH rocks!' --message 'Markdown support'
```
gh is --new --title 'Node GH rocks!' --message 'Markdown support' --user eduardolundgren --repo node-gh
```
gh is --new --title 'Node GH rocks!' --label bug,question,test
```
Option | Usage | Type |
---|
-c , --comment | Required | String |
-n , --number | Required | Number |
-r , --repo | Optional | String |
-u , --user | Optional | String |
Examples
gh is --number 1 --comment 'Node GH rocks!'
```
gh is --number 1 --comment 'Node GH rocks!' --user eduardolundgren --repo node-gh
```
3. List
Option | Usage | Type |
---|
-l , --list | Required | Boolean |
-a , --all | Optional | String |
-r , --repo | Optional | String |
-u , --user | Optional | String |
Examples
gh is --list
```
gh is --list --all
```
gh is --list --user eduardolundgren --repo node-gh
```
Team
Contributing
Contribute new commands to this project by copying and editing the content of Hello World example.
History
-
v0.1.10 May 30, 2013
- Cross platform process.env.HOME
-
v0.1.8 May 30, 2013
- Open issue in browser
- Open pull request url on the browser after sending it
-
v0.1.7 May 30, 2013
- Add hability to set number without
--number
flag
-
v0.1.6 May 30, 2013
- Add the hability to specify a title on
gh pr --submit
- Add password mask on authentication
- Bug fixes
-
v0.1.5 May 29, 2013
- Fix pull request integrity check
-
v0.1.4 May 28, 2013
- Add the hability to create an Issue
- Add the hability to comment on an Issue
- Rename pull request
--comment
to --message
- Rename pull request
--pull
to --number
-
v0.1.3 May 28, 2013
- Remove mustache dependency
-
v0.1.2 May 28, 2013
- Removing wrong number on submit
-
v0.1.1 May 27, 2013
- Add Help task
- Standardize logs
- Bug fixes
-
v0.1.0 May 26, 2013
- Allow log handlebars template from string
- Move apply replacements logic to logger
- Use handlebars templates instead of strings
- Refactoring template integration with logger
- Rename pull request
--comment
to --message
- Add Issues task
-
v0.0.7 May 24, 2013
- Add pull request forward command
- Add Travis continous integration with JSHint
- Create a new website under gh-pages branch
- Update dependency version: git-wrapper@0.1.1
- Add Hello World and Notification tasks
-
v0.0.6 May 17, 2013
- Add hability to merge or rebase pull request
- Add base.getUser and git.merge helpers
-
v0.0.5 May 16, 2013
- Add login to be invoked by default in series
-
v0.0.4 May 16, 2013
- Create ~/.gh.json if needed
-
v0.0.3 May 16, 2013
- Merge user ~/.gh.json with default .gh.json
- Add default .gh.json
- Fix bin path
-
v0.0.2 May 16, 2013
- Add fetch, open/close, message
- Use moment humanize utility
-
v0.0.1 May 14, 2013
License
BSD License