Last Updated: February 25, 2016
·
494
· kenju

GitHub from your Command Line

ghmaster

ghmaster

About

GitHub with Bash.

Shell scripts for manipulating your Git repository.

Install

Run on Terminal

Copy&Paste below commands on your terminal.

curl https://raw.githubusercontent.com/KENJU/ghmaster/master/ghmaster.sh > /usr/local/bin/ghmaster;chmod u+x /usr/local/bin/ghmaster;

In detail, please have a look at below codes with comments.


# Download todo.sh
$ curl https://raw.githubusercontent.com/KENJU/ghmaster/master/ghmaster.sh > /usr/local/bin/ghmaster

# Add permission
$ chmod u+x /usr/local/bin/ghmaster

# Run todo
$ todo -h

If you have not yet added /usr/local/bin to your path, run the below command.


# Add /usr/local/bin to yoru $PATH
$ export PATH=/usr/local/bin:$PATH

Usage

  • Basic
    • help
    • update
  • Repository
    • initialize
    • commit
    • push
    • build
  • Issues
    • list-issues
    • add-issue
    • edit-issue
  • Gist
    • post

Basic

Help

  • show help

$ ghmaster -h
$ ghmaster --help
$ ghmaster help

Update

  • update ghmaster

$ ghmaster -u
$ ghmaster --update
$ ghmaster update

Repository

Initialize

  • make your current repository into git repository
    • create empty README.md
    • create .gitignore
  • ask whether to create Github repository

$ ghmaster -i
$ ghmaster --initialize
$ ghmaster initialize

Commit

  • simply add files and commit with commit message

$ ghmaster -c
$ ghmaster --commit
$ ghmaster commit

Push to Remote Repository

  • commit then push to a remote repository

$ ghmaster -p
$ ghmaster --push
$ ghmaster push

Build

  • Push + push to gh-pages for building gh-pages

$ ghmaster -b
$ ghmaster --build
$ ghmaster build

Issues

list-issues

  • list all issues

$ ghmaster -li
$ ghmaster --list-issues
$ ghmaster list-issues

add-issue

  • add a new issue

$ ghmaster -ai
$ ghmaster --add-issue
$ ghmaster add-issue

edit-issue

  • edit an exsitring issue, for example closing or changing title and body texts.

$ ghmaster -ei
$ ghmaster --edit-issue
$ ghmaster edit-issue

Gist

(under construction...)

License


The MIT License (MIT)

Copyright (c) 2015 Kenju Wagatsuma

Permission is hereby granted, free of charge, to any person 
obtaining a copy of this software and associated documentation 
files (the "Software"), to deal in the Software without 
restriction, including without limitation the rights to use, 
copy, modify, merge, publish, distribute, sublicense, and/or sell 
copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following 
conditions:

The above copyright notice and this permission notice shall be 
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 
OTHER DEALINGS IN THE SOFTWARE.