stow/oh-my-zsh/.oh-my-zsh/plugins/github/README.md

   1 # github plugin
   2
   3 This plugin supports working with GitHub from the command line. It provides a few things:
   4
   5 * Sets up the `hub` wrapper and completions for the `git` command if you have [`hub`](https://github.com/github/hub) installed.
   6 * Completion for the [`github` Ruby gem](https://github.com/defunkt/github-gem).
   7 * Convenience functions for working with repos and URLs.
   8
   9 ### Functions
  10
  11 * `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub
  12 * `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub
  13 * `exist_gh` - Takes an existing repo and pushes it to GitHub
  14
  15
  16 ## Installation
  17
  18 [Hub](https://github.com/github/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.
  19
  20 The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it.
  21
  22 ### Configuration
  23
  24 These settings affect `github`'s behavior.
  25
  26 #### Environment variables
  27
  28 * `$GITHUB_USER`
  29 * `$GITHUB_PASSWORD`
  30
  31 #### Git configuration options
  32
  33 * `github.user` - GitHub username for repo operations
  34
  35 See `man hub` for more details.
  36
  37 ### Homebrew installation note
  38
  39 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`.
  40
  41 ```zsh
  42 if (( ! ${fpath[(I)/usr/local/share/zsh/site-functions]} )); then
  43   FPATH=/usr/local/share/zsh/site-functions:$FPATH
  44 fi
  45 ```