hub: git + hub = github

hub is a command line utility which injects git with GitHub knowledge.

It can used on its own or can serve as a complete, backwards compatible replacement for the git script.

Normal:

$ hub clone rtomayko/tilt
Initialized empty Git repository in /Users/chris/sandbox/tilt/.git/
remote: Counting objects: 307, done.
remote: Compressing objects: 100% (219/219), done.
remote: Total 307 (delta 175), reused 85 (delta 45)
Receiving objects: 100% (307/307), 48.91 KiB, done.
Resolving deltas: 100% (175/175), done.

Aliased:

$ git clone rack/rack
Initialized empty Git repository in /Users/chris/sandbox/rack/.git/
remote: Counting objects: 4005, done.
remote: Compressing objects: 100% (1738/1738), done.
remote: Total 4005 (delta 2505), reused 3620 (delta 2208)
Receiving objects: 100% (4005/4005), 785.82 KiB | 129 KiB/s, done.
Resolving deltas: 100% (2505/2505), done.

Install

hub can be installed most easily as a stand alone script:

curl http://defunkt.github.com/hub/standalone > ~/bin/hub && chmod 0755 !$

It also can be installed using Rubygems:

$ gem install hub -s http://gemcutter.org/

Or from source:

$ git clone git://github.com/defunkt/hub.git
$ cd hub
$ rake install

Once you've installed hub, you can invoke it directly from the command line:

$ hub --version

To get the full experience, alias your git command to run hub by placing the following in your .bash_profile (or relevant startup script):

alias git=hub

Typing hub install <shell> will display install instructions for you shell.

Note that if you're running hub under Rubygems, it may be slow. Installing the standalone script is the fastest (and recommended) method.

Commands

git clone

$ 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 remote add

$ git remote add rtomayko
> git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git

$ git remote add -p pjhyett
> git remote add rtomayko git@github.com:rtomayko/CURRENT_REPO.git

git init

$ git init -g
> git init
> git remote add origin git@github.com:USER/REPO.git

git help

$ git help
> (improved git help)

Prior Art

These projects also aim to either improve git or make interacting with GitHub simpler:

• eg
• github-gem
• gh

Contributing

Once you've made your great commits:

1. Fork hub
2. Create a topic branch - git checkout -b my_branch
3. Push to your branch - git push origin my_branch
4. Create an Issue with a link to your branch
5. That's it!

Meta

• 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
• Gems: http://gemcutter.org/gems/hub

Author

Chris Wanstrath :: chris@ozmm.org :: @defunkt