Customization/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-28 23:31:58 +00:00
Code Releases Activity
ohmyzsh/plugins/github/README.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

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-10-02 05:21:29 +00:00
# github
Minor README fixes
2016-02-15 09:51:17 +00:00
This plugin supports working with GitHub from the command line. It provides a few things:
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-10-02 05:21:29 +00:00
* 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
use https everywhere (#6574) * use https everywhere * use https links on the files that are left Also, removed some broken links and updated redirections.
2018-08-07 18:42:02 +00:00
* `git.io` - Shortens a URL using [git.io](https://git.io)
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-10-02 05:21:29 +00:00
## Installation
use https everywhere (#6574) * use https everywhere * use https links on the files that are left Also, removed some broken links and updated redirections.
2018-08-07 18:42:02 +00:00
[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.
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-10-02 05:21:29 +00:00
use https everywhere (#6574) * use https everywhere * use https links on the files that are left Also, removed some broken links and updated redirections.
2018-08-07 18:42:02 +00:00
The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it.
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-10-02 05:21:29 +00:00
### 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
Minor README fixes
2016-02-15 09:51:17 +00:00
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`.
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-10-02 05:21:29 +00:00
```zsh
if (( ! ${fpath[(I)/usr/local/share/zsh/site-functions]} )); then
FPATH=/usr/local/share/zsh/site-functions:$FPATH
fi
```
Copy permalink