vipyr / github-sh

Installation

Clone this repository somewhere on your file system.

Source the appropriate shell file in your $HOME/.<shell>rc file

Ensure hub is in your $PATH variable before running

Getting Started with the Plugin:

Clone github-sh.

Installing with oh-my-zsh:

mkdir $HOME/.oh-my-zsh/custom/plugin/github-sh
cd $HOME/.oh-my-zsh/custom/plugin/github-sh
ln -s /path/to/github-sh/clone/github-sh.plugin.zsh .
ln -s /path/to/github-sh/clone/_hub .

Add github-sh to the plugins array in your .zshrc.

Installing with zsh:

Add the following to your .zshrc:

fpath=(/path/to/github-sh/clone $fpath)
compdef _hub hub
source /path/to/github-sh/clone/github-sh.plugin.zsh

Installing with bash:

Add the following to your .bashrc:

source /path/to/github-sh/clone/github-sh.plugin.bash

Installing with ksh:

Add the following to your .kshrc:

source /path/to/github-sh/clone/github-sh.plugin.ksh

Setting up your hub wrappers:

Go to github.com

Click your picture in the top right and select "Settings"

Click "Developer Settings" near the bottom on the right

Click "Personal access tokens"

Click the "Generate new token" button in the top right

Confirm your password

Enter a token description (something like "hub in AFS")

Check the following:

       [x] repo
           [x] repo:status
           [x] repo_deployment
           [x] public_repo
           [x] repo:invite
       [x] notifications
       [x] user
           [x] read:user
           [x] user:email
           [x] user:follow
       [x] write:discussion
           [x] read:discussion

Copy the token value IMPORTANT This is the only time you will see this token value!

Run add-gh-host to get everything set.

add-gh-host <hostname> <alias>
  <hostname>  The github hostname to add a hub function for i.e. github.com
  <alias>     The generated function name i.e. gh-pub.  $ gh-pub clone my-repo"

github-sh's Issues

CSH/TCSH Plugin Variants

With support for these two shells, support should be in for all shell variants.

Fill in BASH install steps

The installation steps for BASH are currently undocumented.

_gh Function Doesn't Pass Quoted Arguments in Bash

Using my bash variation (not sure if this also happens in ZSH, but BASH handles quoted arguments really funky) - I'm seeing an issue with the -m "args" in git.

>> git commit -m "simple population of the readme" 
error: pathspec 'population' did not match any file(s) known to git.
error: pathspec 'of' did not match any file(s) known to git.
error: pathspec 'the' did not match any file(s) known to git.
error: pathspec 'readme' did not match any file(s) known to git.