adphi/oh-my-zsh
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
3841115f54
oh-my-zsh/plugins/github
History
Andrew Janke 24492a2fdb Update github plugin to work with current hub versions 
Removes old completion setup that breaks with current _git and _hub completions.
Ruby is no longer required by hub; removes that test.
Does not define new completions for hub; they are now defined by hub itself.
Change the functions to use hub to create the repos on GitHub.
Add error checking to the functions.
Removes apparently-unused _github completion definition.
2015-11-06 04:10:33 -05:00
..
github.plugin.zsh Update github plugin to work with current hub versions 2015-11-06 04:10:33 -05:00
README.md Update github plugin to work with current hub versions 2015-11-06 04:10:33 -05:00

README.md

github

This plugin supports working with GitHub the command line. It provides a few things:

  • Sets up the hub wrapper and completions for the git command if you have hub installed.
  • Completion for the github Ruby gem.
  • Convenience functions for working with repos and URLs.

Functions

  • empty_gh - Creates a new empty repo (with a README.md) and pushes it to GitHub
  • new_gh - Initializes an existing directory as a repo and pushes it to GitHub
  • exist_gh - Takes an existing repo and pushes it to GitHub
  • git.io - Shortens a URL using git.io

Installation

Hub needs to be installed if you want to use it. On OS X with Homebrew, this can be done with brew install hub. The hub completion definition needs to be added to your $FPATH before initializing OMZ.

The github Ruby gem needs to be installed if you want to use it.

Configuration

These settings affect github's behavior.

Environment variables

  • $GITHUB_USER
  • $GITHUB_PASSWORD

Git configuration options

  • github.user - GitHub username for repo operations

See man hub for more details.

Homebrew installation note

If you have installed hub using Homebrew, its completions may not be on your $FPATH if you are using the system zsh. Homebrew installs zsh completion definitions to /usr/local/share/zsh/site-functions, which on $FPATH for the Homebrew-installed zsh, but not for the system zsh. If you want it to work with the system zsh, add this to your ~/.zshrc before it sources oh-my-zsh.sh.

if (( ! ${fpath[(I)/usr/local/share/zsh/site-functions]} )); then
  FPATH=/usr/local/share/zsh/site-functions:$FPATH
fi