ylib/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-11 23:53:43 +08:00
Code Projects Releases Wiki Activity
eb244d9ec0
ohmyzsh/plugins/github
History
Sharat M R f28c0a81b7 Moved git.io url to https 
git.io now redirects to https. So the current function break. Changing it to https fixes the issue.
2016-04-16 06:52:58 +05:30
..
_hub Add hub's completion file 2015-12-15 11:57:24 +01:00
github.plugin.zsh Moved git.io url to https 2016-04-16 06:52:58 +05:30
README.md Minor README fixes 2016-02-15 10:51:17 +01:00

README.md

github

This plugin supports working with GitHub from 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 will be 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