hub
is a command line utility which adds GitHub knowledge to git
.
It can be used on its own or as a git
wrapper.
Normal:
$ hub clone rtomayko/tilt
Expands to:
$ git clone git://github.com/rtomayko/tilt.git
Wrapping git
:
$ git clone rack/rack
Expands to:
$ git clone git://github.com/rack/rack.git
hub requires you have git
installed and in your $PATH
. It also
requires Ruby 1.8.6+ or Ruby 1.9.1+. No other libraries necessary.
hub
is most easily installed as a standalone script:
curl http://defunkt.io/hub/standalone -sLo ~/bin/hub &&
chmod 755 ~/bin/hub
Assuming ~/bin/
is in your $PATH
, you're ready to roll:
$ hub version
git version 1.7.0.4
hub version 1.1.0
$ brew install hub
$ which hub
/usr/local/bin/hub
$ hub version
...
Though not recommended, hub
can also be installed as a RubyGem:
$ gem install hub
(It's not recommended for casual use because of the RubyGems startup time. See this gist for information.)
$ gem install hub
$ hub hub standalone > ~/bin/hub && chmod 755 ~/bin/hub
This installs a standalone version which doesn't require RubyGems to run.
You can also install from source:
$ git clone git://github.com/defunkt/hub.git
$ cd hub
$ rake install prefix=/usr/local
Is your prompt slow? It may be hub.
-
Check that it's not installed using RubyGems.
-
Check that RUBYOPT isn't loading anything shady:
$ echo $RUBYOPT
-
Check that your system Ruby is speedy:
$ time /usr/bin/env ruby -e0
If #3 is slow, it may be your GC settings.
hub
works best when it wraps git
. This is not dangerous - your
normal git commands should all work. hub merely adds some sugar.
Typing hub alias <shell>
will display alias instructions for
your shell. hub alias
alone will show the known shells.
For example:
$ hub alias bash
Run this in your shell to start using `hub` as `git`:
alias git=hub
You should place this command in your .bash_profile
or other startup
script to ensure runs on login.
The alias command can also be eval'd directly using the -s
flag:
$ eval `hub alias -s bash`
Assuming you've aliased hub
to git
, the following commands now have
superpowers:
$ git clone schacon/ticgit
> git clone git://github.com/schacon/ticgit.git
$ git clone -p schacon/ticgit
> git clone git@github.com:schacon/ticgit.git
$ git clone resque
> git clone git://github.com/YOUR_USER/resque.git
$ git clone -p resque
> git clone git@github.com:YOUR_USER/resque.git
$ git remote add rtomayko
> git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git
$ git remote add -p rtomayko
> git remote add rtomayko git@github.com:rtomayko/CURRENT_REPO.git
$ git remote add origin
> git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git
$ git fetch mislav
> git remote add mislav git://github.com/mislav/REPO.git
> git fetch mislav
$ git fetch mislav,xoebus
> git remote add mislav ...
> git remote add xoebus ...
> git fetch --multiple mislav xoebus
$ git cherry-pick http://github.com/mislav/REPO/commit/SHA
> git remote add -f mislav git://github.com/mislav/REPO.git
> git cherry-pick SHA
$ git cherry-pick mislav@SHA
> git remote add -f mislav git://github.com/mislav/CURRENT_REPO.git
> git cherry-pick SHA
$ git cherry-pick mislav@SHA
> git fetch mislav
> git cherry-pick SHA
$ git am https://github.com/defunkt/hub/pull/55
> curl https://github.com/defunkt/hub/pull/55.patch -o /tmp/55.patch
> git am /tmp/55.patch
$ git am --ignore-whitespace https://github.com/davidbalbert/hub/commit/fdb9921
> curl https://github.com/davidbalbert/hub/commit/fdb9921.patch -o /tmp/fdb9921.patch
> git am --ignore-whitespace /tmp/fdb9921.patch
$ git apply https://gist.github.com/8da7fb575debd88c54cf
> curl https://gist.github.com/8da7fb575debd88c54cf.txt -o /tmp/gist-8da7fb575debd88c54cf.txt
> git apply /tmp/gist-8da7fb575debd88c54cf.txt
$ git fork
[ repo forked on GitHub ]
> git remote add -f YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
[ in a branch called my_branch on CURRENT_REPO ]
$ git pullrequest -t "Issue Title" -y "Issue description."
[ pull request sent on GitHub, into CURRENT_REPO:master from CURRENT_REPO:my_branch ]
[ on a fork of mislav:CURRENT_REPO ]
$ git pullrequest -t "Issue Title" -y "Issue description." -b mislav:master
[ pull request sent on GitHub, into mislav/CURRENT_REPO:master from YOUR_USER/CURRENT_REPO:master ]
$ git pullrequest -i 123
[ existing issue #123 turned into a pull request from the current branch ]
$ git create
[ repo created on GitHub ]
> git remote add origin git@github.com:YOUR_USER/CURRENT_REPO.git
# with description:
$ git create -d 'It shall be mine, all mine!'
$ git create recipes
[ repo created on GitHub ]
> git remote add origin git@github.com:YOUR_USER/recipes.git
$ git create sinatra/recipes
[ repo created in GitHub organization ]
> git remote add origin git@github.com:sinatra/recipes.git
$ git init -g
> git init
> git remote add origin git@github.com:YOUR_USER/REPO.git
$ git push origin,staging,qa bert_timeout
> git push origin bert_timeout
> git push staging bert_timeout
> git push qa bert_timeout
$ git browse
> open https://github.com/YOUR_USER/CURRENT_REPO
$ git browse -- commit/SHA
> open https://github.com/YOUR_USER/CURRENT_REPO/commit/SHA
$ git browse -- issues
> open https://github.com/YOUR_USER/CURRENT_REPO/issues
$ git browse schacon/ticgit
> open https://github.com/schacon/ticgit
$ git browse schacon/ticgit commit/SHA
> open https://github.com/schacon/ticgit/commit/SHA
$ git browse resque
> open https://github.com/YOUR_USER/resque
$ git browse resque network
> open https://github.com/YOUR_USER/resque/network
$ git compare refactor
> open https://github.com/CURRENT_REPO/compare/refactor
$ git compare 1.0..1.1
> open https://github.com/CURRENT_REPO/compare/1.0...1.1
$ git compare -u fix
> (https://github.com/CURRENT_REPO/compare/fix)
$ git compare other-user patch
> open https://github.com/other-user/REPO/compare/patch
$ hub submodule add wycats/bundler vendor/bundler
> git submodule add git://github.com/wycats/bundler.git vendor/bundler
$ hub submodule add -p wycats/bundler vendor/bundler
> git submodule add git@github.com:wycats/bundler.git vendor/bundler
$ hub submodule add -b ryppl ryppl/pip vendor/pip
> git submodule add -b ryppl git://github.com/ryppl/pip.git vendor/pip
$ git help
> (improved git help)
$ git help hub
> (hub man page)
To get the most out of hub
, you'll want to ensure your GitHub login
is stored locally in your Git config or environment variables.
To test it run this:
$ git config --global github.user
If you see nothing, you need to set the config setting:
$ git config --global github.user YOUR_USER
For commands that require write access to GitHub (such as fork
), you'll want to
setup "github.token" as well. See local GitHub config guide for more information.
Want to use environment variables instead of a local gitconfig?
GITHUB_USER
- If set, this will be used instead of thegithub.user
config value to determine your GitHub username.GITHUB_TOKEN
- If set, this will be used instead of thegithub.token
config value to determine your GitHub API token.
If you prefer http://
clones to git://
clones, you can set the
hub.http-clone
option to true using git-config
.
For example:
$ git clone defunkt/repl
< git clone >
$ git config --global --bool hub.http-clone true
$ git clone defunkt/repl
< http clone >
Or you can enter this manually into your ~/.gitconfig
file:
$ cat ~/.gitconfig
[hub]
http-clone = yes
These projects also aim to either improve git or make interacting with GitHub simpler:
Once you've made your great commits:
- Fork hub
- Create a topic branch -
git checkout -b my_branch
- Push to your branch -
git push origin my_branch
- Create an Issue with a link to your branch
- That's it!
You will need the following gems (and their dependencies) to
contribute to hub
:
rake
(gem install rake
)kicker
(gem install kicker
)turn
(gem install turn
)mg
(gem install mg
)ronn
(gem install ronn
)webmock
(gem install webmock
)
- Code:
git clone git://github.com/defunkt/hub.git
- Home: http://github.com/defunkt/hub
- Bugs: http://github.com/defunkt/hub/issues
- List: http://groups.google.com/group/github
- Test: http://runcoderun.com/defunkt/hub
- Gems: http://gemcutter.org/gems/hub