Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

158 lines (131 sloc) 5.647 kb
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ron/v0.3'>
<title>hub(1) -- git + hub = github</title>
<style type='text/css'>
body {margin:0}
#man, #man code, #man pre, #man tt, #man kbd, #man samp {
font-family:consolas,monospace;
font-size:16px;
line-height:1.3;
color:#343331;
background:#fff; }
#man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
#man h1, #man h2, #man h3 { color:#232221;clear:left }
#man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
#man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
#man h3 { font-size:16px; margin:0 0 0 4ex; }
#man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
#man pre {
color:#333231;
background:#edeceb;
padding:5px 7px;
margin:0px 0 20px 0;
border-left:2ex solid #ddd}
#man pre + h2, #man pre + h3 {
margin-top:22px;
}
#man h2 + pre, #man h3 + pre {
margin-top:5px;
}
#man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
#man dt { margin:0; clear:left }
#man dt.flush { float:left; width:8ex }
#man dd { margin:0 0 0 9ex }
#man code, #man strong, #man b { font-weight:bold; color:#131211; }
#man pre code { font-weight:normal; color:#232221; background:inherit }
#man em, var, u {
font-style:normal; color:#333231; border-bottom:1px solid #999; }
#man h1.man-title { display:none; }
#man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
float:left; width:33%; list-style-type:none;
text-transform:uppercase; font-size:18px; color:#999;
letter-spacing:1px;}
#man ol.man { width:100%; }
#man ol.man li.tl { text-align:left }
#man ol.man li.tc { text-align:center;letter-spacing:4px }
#man ol.man li.tr { text-align:right }
#man ol.man a { color:#999 }
#man ol.man a:hover { color:#333231 }
</style>
</head>
<body>
<div id='man'>
<h1 class='man-title'>hub(1)</h1>
<ol class='head man'>
<li class='tl'>hub(1)</li>
<li class='tc'>Git Manual</li>
<li class='tr'>hub(1)</li>
</ol>
<h2 id='NAME'>NAME</h2>
<p><code>hub</code> -- git + hub = github</p>
<h2>SYNOPSIS</h2>
<p><code>hub</code> <var>COMMAND</var> <var>OPTIONS</var><br>
<code>hub alias</code> [<code>-s</code>] <var>SHELL</var></p>
<p><code>git init -g</code> <var>OPTIONS</var><br>
<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br>
<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>]<br>
</p>
<h2>DESCRIPTION</h2>
<p><code>hub</code> enhances various <code>git</code> commands with GitHub remote expansion. The
alias command displays information on configuring your environment:</p>
<dl>
<dt>
<code>hub alias</code> [<code>-s</code>] <var>SHELL</var>
</dt>
<dd>Writes shell aliasing code for <var>SHELL</var> (<code>bash</code>, <code>sh</code>, <code>zsh</code>,
<code>csh</code>) to standard output. With the <code>-s</code> option, the output of
this command can be evaluated directly within the shell:
<code>eval $(hub alias -s bash)</code>
</dd>
</dl>
<p>After configuring the alias, the following commands have superpowers:</p>
<dl>
<dt>
<code>git init</code> <code>-g</code> <var>OPTIONS</var>
</dt>
<dd><p>Create a git repository as with git-init(1) and add remote <code>origin</code> 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's basename.</p></dd>
<dt>
<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var><code>/</code>]<var>REPOSITORY</var> <var>DIRECTORY</var>
</dt>
<dd><p>Clone repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
<var>DIRECTORY</var> as with git-clone(1). When <var>USER</var>/ is omitted, assumes
your GitHub login. With <code>-p</code>, use private remote
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
<dt>
<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[<code>/</code><var>REPOSITORY</var>]</dt>
<dd><p>Add remote "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" as with
git-remote(1). When /<var>REPOSITORY</var> is omitted, the basename of the
current working directory is used. With <code>-p</code>, use private remote
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
<dt><code>git help</code></dt>
<dd><p>Display enhanced git-help(1).</p></dd>
</dl>
<h2>CONFIGURATION</h2>
<p>Use git-config(1) to display the currently configured GitHub username:</p>
<pre><code>$ git config --global github.user
</code></pre>
<p>Or, set the GitHub username with:</p>
<pre><code>$ git config --global github.user &lt;username&gt;
</code></pre>
<p>See <a href="http://github.com/guides/local-github-config">http://github.com/guides/local-github-config</a> for more information.</p>
<h2>BUGS</h2>
<p><a href="http://github.com/defunkt/hub/issues">http://github.com/defunkt/hub/issues</a></p>
<h2>AUTHOR</h2>
<p>Chris Wanstrath :: chris@ozmm.org :: @defunkt</p>
<h2>SEE ALSO</h2>
<p>git(1), git-clone(1), git-remote(1), git-init(1),
<a href="http://github.com">http://github.com</a>,
<a href="http://github.com/defunkt/hub">http://github.com/defunkt/hub</a></p>
<ol class='foot man'>
<li class='tl'>DEFUNKT</li>
<li class='tc'>December 2009</li>
<li class='tr'>hub(1)</li>
</ol>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.