<!DOCTYPE html> <html> <head>

<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>hub(1) - git + hub = github</title>
<style type='text/css' media='all'>
   style: man   
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>

</head> <!–

The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.

The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.

–> <body id='manpage'>

<div class='mp' id='man'>

<div class='man-navigation' style='display:none'>
  <a href="#NAME">NAME</a>
  <a href="#SYNOPSIS">SYNOPSIS</a>
  <a href="#DESCRIPTION">DESCRIPTION</a>
  <a href="#CONFIGURATION">CONFIGURATION</a>
  <a href="#EXAMPLES">EXAMPLES</a>
  <a href="#BUGS">BUGS</a>
  <a href="#AUTHORS">AUTHORS</a>
  <a href="#SEE-ALSO">SEE ALSO</a>
</div>

<ol class='man-decor man-head man head'>
  <li class='tl'>hub(1)</li>
  <li class='tc'>Hub Manual</li>
  <li class='tr'>hub(1)</li>
</ol>

<h2 id="NAME">NAME</h2>

<p class=“man-name”>

<code>hub</code> - <span class="man-whatis">git + hub = github</span>

</p>

<h2 id=“SYNOPSIS”>SYNOPSIS</h2>

<p>hub [--noop] <var>COMMAND</var> <var>OPTIONS</var><br /> hub alias [-s] [<var>SHELL</var>]</p>

<h3 id=“Expanded-git-commands-”>Expanded git commands:</h3>

<p>git init -g <var>OPTIONS</var><br /> git clone [-p] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br /> git remote add [-p] <var>OPTIONS</var> <REPOSITORY”>var>USER<br /> git fetch <REPOSITORY“>var>USER</dt><dd><p>Add remote ”git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git“ as with <span class=”man-ref“>git-remote<span class=”s“>(1)</span></span>. When /<var>REPOSITORY</var> is omitted, the basename of the current working directory is used. With -p, use private remote ”git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git“. If <var>USER</var> is ”origin“ then uses your GitHub login.</p></dd> <dt>git remote set-url [-p] <var>OPTIONS</var> <var>REMOTE-NAME</var> <USER-2,…“>var>USER-1,</dt><dd><p>Adds missing remote(s) with git remote add prior to fetching. New remotes are only added if they correspond to valid forks on GitHub.</p></dd> <dt>git checkout <var>PULLREQ-URL</var> [<var>BRANCH</var>]</dt><dd><p>Checks out the head of the pull request as a local branch, to allow for reviewing, rebasing and otherwise cleaning up the commits in the pull request before merging. The name of the local branch can explicitly be set with <var>BRANCH</var>.</p></dd> <dt>git merge <var>PULLREQ-URL</var></dt><dd><p>Merge the pull request with a commit message that includes the pull request ID and title, similar to the GitHub Merge Button.</p></dd> <dt>git cherry-pick <var>GITHUB-REF</var></dt><dd><p>Cherry-pick a commit from a fork using either full URL to the commit or GitHub-flavored Markdown notation, which is user@sha. If the remote doesn't yet exist, it will be added. A git fetch &lt;user> is issued prior to the cherry-pick attempt.</p></dd> <dt>git [am|apply] <var>GITHUB-URL</var></dt><dd><p>Downloads the patch file for the pull request or commit at the URL and applies that patch from disk with git am or git apply. Similar to cherry-pick, but doesn't add new remotes. git am creates commits while preserving authorship info while apply only applies the patch to the working copy.</p></dd> <dt>git push <var>REMOTE-1</var>,<var>REMOTE-2</var>,…,<var>REMOTE-N</var> [<var>REF</var>]</dt><dd><p>Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing multiple git push commands.</p></dd> <dt>git submodule add [-p] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var></dt><dd><p>Submodule repository ”git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git“ into <var>DIRECTORY</var> as with <span class=”man-ref“>git-submodule<span class=”s“>(1)</span></span>. When <var>USER</var>/ is omitted, assumes your GitHub login. With -p, use private remote ”git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git“.</p></dd> <dt>git help</dt><dd><p>Display enhanced <span class=”man-ref“>git-help<span class=”s“>(1)</span></span>.</p></dd> </dl>

<p>hub also adds some custom commands that are otherwise not present in git:</p>

<dl> <dt>git create [<var>NAME</var>] [-p] [-d <var>DESCRIPTION</var>] [-h <var>HOMEPAGE</var>]</dt><dd><p>Create a new public GitHub repository from the current git repository and add remote origin at “git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git”; <var>USER</var> is your GitHub username and <var>REPOSITORY</var> is the current working directory name. To explicitly name the new repository, pass in <var>NAME</var>, optionally in <var>ORGANIZATION</var>/<var>NAME</var> form to create under an organization you're a member of. With -p, create a private repository, and with -d and -h set the repository's description and homepage URL, respectively.</p></dd> <dt>git browse [-u] [[<var>USER</var>/]<var>REPOSITORY</var>] [SUBPAGE]</dt><dd><p>Open repository's GitHub page in the system's default web browser using open(1) or the BROWSER env variable. If the repository isn't specified, browse opens the page of the repository found in the current directory. If SUBPAGE is specified, the browser will open on the specified subpage: one of “wiki”, “commits”, “issues” or other (the default is “tree”). With -u, outputs the URL rather than opening the browser.</p></dd> <dt>git compare [-u] [<var>USER</var>] [[<var>START</var>…]<var>END</var>]</dt><dd><p>Open a GitHub compare view page in the system's default web browser. <var>START</var> to <var>END</var> are branch names, tag names, or commit SHA1s specifying the range of history to compare. If a range with two dots (a..b) is given, it will be transformed into one with three dots. If <var>START</var> is omitted, GitHub will compare against the base branch (the default is “master”). If <var>END</var> is omitted, GitHub compare view is opened for the current branch. With -u, outputs the URL rather than opening the browser.</p></dd> <dt>git fork [--no-remote]</dt><dd><p>Forks the original project (referenced by “origin” remote) on GitHub and adds a new remote for it under your username.</p></dd> <dt>git pull-request [-o|--browse] [-f] [-m <var>MESSAGE</var>|-F <var>FILE</var>|-i <var>ISSUE</var>|<var>ISSUE-URL</var>] [-b <var>BASE</var>] [-h <var>HEAD</var>]</dt><dd><p>Opens a pull request on GitHub for the project that the “origin” remote points to. The default head of the pull request is the current branch. Both base and head of the pull request can be explicitly given in one of the following formats: “branch”, “owner:branch”, “owner/repo:branch”. This command will abort operation if it detects that the current topic branch has local commits that are not yet pushed to its upstream branch on the remote. To skip this check, use -f.</p>

<p>Without <var>MESSAGE</var> or <var>FILE</var>, a text editor will open in which title and body of the pull request can be entered in the same manner as git commit message. Pull request message can also be passed via stdin with -F -.</p>

<p>With -o or --browse, the new pull request will open in the web browser.</p>

<p>Issue to pull request conversion via -i &lt;ISSUE> or <var>ISSUE-URL</var> arguments is deprecated and will likely be removed from the future versions of both hub and GitHub API.</p></dd> <dt>git ci-status [-v] [<var>COMMIT</var>]</dt><dd><p>Looks up the SHA for <var>COMMIT</var> in GitHub Status API and displays the latest status. Exits with one of:<br /> success (0), error (1), failure (1), pending (2), no status (3)</p>

<p>If -v is given, additionally print the URL to CI build results.</p></dd> </dl>

<h2 id=“CONFIGURATION”>CONFIGURATION</h2>

<p>Hub will prompt for GitHub username &amp; password the first time it needs to access the API and exchange it for an OAuth token, which it saves in “~/.config/hub”.</p>

<p>To avoid being prompted, use <var>GITHUB_USER</var> and <var>GITHUB_PASSWORD</var> environment variables.</p>

<p>If you prefer the HTTPS protocol for GitHub repositories, you can set “hub.protocol” to “https”. This will affect clone, fork, remote add and other operations that expand references to GitHub repositories as full URLs that otherwise use git and ssh protocols.</p>

<pre>$ git config --global hub.protocol https </pre>

<h3 id=“GitHub-Enterprise”>GitHub Enterprise</h3>

<p>By default, hub will only work with repositories that have remotes which point to github.com. GitHub Enterprise hosts need to be whitelisted to configure hub to treat such remotes same as github.com:</p>

<pre>$ git config --global --add hub.host my.git.org </pre>

<p>The default host for commands like init and clone is still github.com, but this can be affected with the <var>GITHUB_HOST</var> environment variable:</p>

<pre>$ GITHUB_HOST=my.git.org git clone myproject </pre>

<h2 id=“EXAMPLES”>EXAMPLES</h2>

<h3 id=“git-clone”>git clone</h3>

<pre><code>$ git clone schacon/ticgit &gt; git clone git://github.com/schacon/ticgit.git

$ git clone -p schacon/ticgit &gt; git clone git@github.com:schacon/ticgit.git

$ git clone resque &gt; git clone git@github.com/YOUR_USER/resque.git </code></pre>

<h3 id=“git-remote-add”>git remote add</h3>

<pre><code>$ git remote add rtomayko &gt; git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git

$ git remote add -p rtomayko &gt; git remote add rtomayko git@github.com:rtomayko/CURRENT_REPO.git

$ git remote add origin &gt; git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git </code></pre>

<h3 id=“git-fetch”>git fetch</h3>

<pre><code>$ git fetch mislav &gt; git remote add mislav git://github.com/mislav/REPO.git &gt; git fetch mislav

$ git fetch mislav,xoebus &gt; git remote add mislav … &gt; git remote add xoebus … &gt; git fetch –multiple mislav xoebus </code></pre>

<h3 id=“git-cherry-pick”>git cherry-pick</h3>

<pre><code>$ git cherry-pick github.com/mislav/REPO/commit/SHA &gt; git remote add -f mislav git://github.com/mislav/REPO.git &gt; git cherry-pick SHA

$ git cherry-pick mislav@SHA &gt; git remote add -f mislav git://github.com/mislav/CURRENT_REPO.git &gt; git cherry-pick SHA

$ git cherry-pick mislav@SHA &gt; git fetch mislav &gt; git cherry-pick SHA </code></pre>

<h3 id=“git-am-git-apply”>git am, git apply</h3>

<pre><code>$ git am github.com/defunkt/hub/pull/55

downloads patch via API

&gt; git am /tmp/55.patch

$ git am –ignore-whitespace github.com/davidbalbert/hub/commit/fdb9921

downloads patch via API

&gt; git am –ignore-whitespace /tmp/fdb9921.patch

$ git apply gist.github.com/8da7fb575debd88c54cf

downloads patch via API

&gt; git apply /tmp/gist-8da7fb575debd88c54cf.txt </code></pre>

<h3 id=“git-fork”>git fork</h3>

<pre><code>$ git fork

repo forked on GitHub

&gt; git remote add -f YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git </code></pre>

<h3 id=“git-pull-request”>git pull-request</h3>

<pre><code># while on a topic branch called “feature”: $ git pull-request

opens text editor to edit title &amp; body for the request
opened pull request on GitHub for “YOUR_USER:feature”

# explicit title, pull base &amp; head: $ git pull-request -m “Implemented feature X” -b defunkt:master -h mislav:feature </code></pre>

<h3 id=“git-checkout”>git checkout</h3>

<pre><code>$ git checkout github.com/defunkt/hub/pull/73 &gt; git remote add -f -t feature git://github:com/mislav/hub.git &gt; git checkout –track -B mislav-feature mislav/feature

$ git checkout github.com/defunkt/hub/pull/73 custom-branch-name </code></pre>

<h3 id=“git-merge”>git merge</h3>

<pre>$ git merge https://github.com/defunkt/hub/pull/73 &gt; git fetch git://github.com/mislav/hub.git +refs/heads/feature:refs/remotes/mislav/feature &gt; git merge mislav/feature --no-ff -m 'Merge pull request #73 from mislav/feature...' </pre>

<h3 id=“git-create”>git create</h3>

<pre><code>$ git create

repo created on GitHub

&gt; 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

&gt; git remote add origin git@github.com:YOUR_USER/recipes.git

$ git create sinatra/recipes

repo created in GitHub organization

&gt; git remote add origin git@github.com:sinatra/recipes.git </code></pre>

<h3 id=“git-init”>git init</h3>

<pre>$ git init -g &gt; git init &gt; git remote add origin git@github.com:YOUR_USER/REPO.git </pre>

<h3 id=“git-push”>git push</h3>

<pre>$ git push origin,staging,qa bert_timeout &gt; git push origin bert_timeout &gt; git push staging bert_timeout &gt; git push qa bert_timeout </pre>

<h3 id=“git-browse”>git browse</h3>

<pre><code>$ git browse &gt; open github.com/YOUR_USER/CURRENT_REPO

$ git browse – commit/SHA &gt; open github.com/YOUR_USER/CURRENT_REPO/commit/SHA

$ git browse – issues &gt; open github.com/YOUR_USER/CURRENT_REPO/issues

$ git browse schacon/ticgit &gt; open github.com/schacon/ticgit

$ git browse schacon/ticgit commit/SHA &gt; open github.com/schacon/ticgit/commit/SHA

$ git browse resque &gt; open github.com/YOUR_USER/resque

$ git browse resque network &gt; open github.com/YOUR_USER/resque/network </code></pre>

<h3 id=“git-compare”>git compare</h3>

<pre><code>$ git compare refactor &gt; open github.com/CURRENT_REPO/compare/refactor

$ git compare 1.0..1.1 &gt; open github.com/CURRENT_REPO/compare/1.0…1.1

$ git compare -u fix &gt; (github.com/CURRENT_REPO/compare/fix)

$ git compare other-user patch &gt; open github.com/other-user/REPO/compare/patch </code></pre>

<h3 id=“git-submodule”>git submodule</h3>

<pre><code>$ git submodule add wycats/bundler vendor/bundler &gt; git submodule add git://github.com/wycats/bundler.git vendor/bundler

$ git submodule add -p wycats/bundler vendor/bundler &gt; git submodule add git@github.com:wycats/bundler.git vendor/bundler

$ git submodule add -b ryppl –name pip ryppl/pip vendor/pip &gt; git submodule add -b ryppl –name pip git://github.com/ryppl/pip.git vendor/pip </code></pre>

<h3 id=“git-ci-status”>git ci-status</h3>

<pre>$ git ci-status [commit] &gt; (prints CI state of commit and exits with appropriate code) &gt; One of: success (0), error (1), failure (1), pending (2), no status (3) </pre>

<h3 id=“git-help”>git help</h3>

<pre>$ git help &gt; (improved git help) $ git help hub &gt; (hub man page) </pre>

<h2 id=“BUGS”>BUGS</h2>

<p><a href=“github.com/github/hub/issues” data-bare-link=“true”>github.com/github/hub/issues>

<h2 id=“AUTHORS”>AUTHORS</h2>

<p><a href=“github.com/github/hub/contributors” data-bare-link=“true”>github.com/github/hub/contributors>

<h2 id=“SEE-ALSO”>SEE ALSO</h2>

<p><span class=“man-ref”>git<span class=“s”>(1)</span></span>, <span class=“man-ref”>git-clone<span class=“s”>(1)</span></span>, <span class=“man-ref”>git-remote<span class=“s”>(1)</span></span>, <span class=“man-ref”>git-init<span class=“s”>(1)</span></span>, <a href=“github.com” data-bare-link=“true”>github.com>, <a href=“github.com/github/hub” data-bare-link=“true”>github.com/github/hub>

<ol class='man-decor man-foot man foot'>
  <li class='tl'>GITHUB</li>
  <li class='tc'>February 2014</li>
  <li class='tr'>hub(1)</li>
</ol>

</div>

</body> </html>