1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.2.5" />
7 <style type=
"text/css">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-clone(
1)
</title>
312 git-clone(
1) Manual Page
315 <div class=
"sectionbody">
317 Clone a repository into a new directory
322 <div class=
"sectionbody">
323 <div class=
"verseblock">
324 <div class=
"content"><em>git clone
</em> [--template=
<template_directory
>]
325 [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
326 [-o
<name
>] [-b
<name
>] [-u
<upload-pack
>] [--reference
<repository
>]
327 [--depth
<depth
>] [--recursive] [--]
<repository
> [
<directory
>]
</div></div>
329 <h2 id=
"_description">DESCRIPTION
</h2>
330 <div class=
"sectionbody">
331 <div class=
"para"><p>Clones a repository into a newly created directory, creates
332 remote-tracking branches for each branch in the cloned repository
333 (visible using
<tt>git branch -r
</tt>), and creates and checks out an
334 initial branch that is forked from the cloned repository's
335 currently active branch.
</p></div>
336 <div class=
"para"><p>After the clone, a plain
<tt>git fetch
</tt> without arguments will update
337 all the remote-tracking branches, and a
<tt>git pull
</tt> without
338 arguments will in addition merge the remote master branch into the
339 current master branch, if any.
</p></div>
340 <div class=
"para"><p>This default configuration is achieved by creating references to
341 the remote branch heads under
<tt>refs/remotes/origin
</tt> and
342 by initializing
<tt>remote.origin.url
</tt> and
<tt>remote.origin.fetch
</tt>
343 configuration variables.
</p></div>
345 <h2 id=
"_options">OPTIONS
</h2>
346 <div class=
"sectionbody">
347 <div class=
"vlist"><dl>
356 When the repository to clone from is on a local machine,
357 this flag bypasses the normal
"git aware" transport
358 mechanism and clones the repository by making a copy of
359 HEAD and everything under objects and refs directories.
360 The files under
<tt>.git/objects/
</tt> directory are hardlinked
361 to save space when possible. This is now the default when
362 the source repository is specified with
<tt>/path/to/repo
</tt>
363 syntax, so it essentially is a no-op option. To force
364 copying instead of hardlinking (which may be desirable
365 if you are trying to make a back-up of your repository),
366 but still avoid the usual
"git aware" transport
367 mechanism,
<tt>--no-hardlinks
</tt> can be used.
375 Optimize the cloning process from a repository on a
376 local filesystem by copying files under
<tt>.git/objects
</tt>
388 When the repository to clone is on the local machine,
389 instead of using hard links, automatically setup
390 <tt>.git/objects/info/alternates
</tt> to share the objects
391 with the source repository. The resulting repository
392 starts out without any object of its own.
394 <div class=
"para"><p><strong>NOTE
</strong>: this is a possibly dangerous operation; do
<strong>not
</strong> use
395 it unless you understand what it does. If you clone your
396 repository using this option and then delete branches (or use any
397 other git command that makes any existing commit unreferenced) in the
398 source repository, some objects may become unreferenced (or dangling).
399 These objects may be removed by normal git operations (such as
<tt>git commit
</tt>)
400 which automatically call
<tt>git gc --auto
</tt>. (See
<a href=
"git-gc.html">git-gc(
1)
</a>.)
401 If these objects are removed and were referenced by the cloned repository,
402 then the cloned repository will become corrupt.
</p></div>
403 <div class=
"para"><p>Note that running
<tt>git repack
</tt> without the
<tt>-l
</tt> option in a repository
404 cloned with
<tt>-s
</tt> will copy objects from the source repository into a pack
405 in the cloned repository, removing the disk space savings of
<tt>clone -s
</tt>.
406 It is safe, however, to run
<tt>git gc
</tt>, which uses the
<tt>-l
</tt> option by
408 <div class=
"para"><p>If you want to break the dependency of a repository cloned with
<tt>-s
</tt> on
409 its source repository, you can simply run
<tt>git repack -a
</tt> to copy all
410 objects from the source repository into a pack in the cloned repository.
</p></div>
413 --reference
<repository
>
417 If the reference repository is on the local machine,
418 automatically setup
<tt>.git/objects/info/alternates
</tt> to
419 obtain objects from the reference repository. Using
420 an already existing repository as an alternate will
421 require fewer objects to be copied from the repository
422 being cloned, reducing network and local storage costs.
424 <div class=
"para"><p><strong>NOTE
</strong>: see the NOTE for the
<tt>--shared
</tt> option.
</p></div>
434 Operate quietly. Progress is not reported to the standard
435 error stream. This flag is also passed to the `rsync'
447 Run verbosely. Does not affect the reporting of progress status
448 to the standard error stream.
456 Progress status is reported on the standard error stream
457 by default when it is attached to a terminal, unless -q
458 is specified. This flag forces progress status even if the
459 standard error stream is not directed to a terminal.
470 No checkout of HEAD is performed after the clone is complete.
478 Make a
<em>bare
</em> GIT repository. That is, instead of
479 creating
<tt><directory
></tt> and placing the administrative
480 files in
<tt><directory
>/.git
</tt>, make the
<tt><directory
></tt>
481 itself the
<tt>$GIT_DIR
</tt>. This obviously implies the
<tt>-n
</tt>
482 because there is nowhere to check out the working tree.
483 Also the branch heads at the remote are copied directly
484 to corresponding local branch heads, without mapping
485 them to
<tt>refs/remotes/origin/
</tt>. When this option is
486 used, neither remote-tracking branches nor the related
487 configuration variables are created.
495 Set up a mirror of the remote repository. This implies
<tt>--bare
</tt>.
499 --origin
<name
>
506 Instead of using the remote name
<tt>origin
</tt> to keep track
507 of the upstream repository, use
<tt><name
></tt>.
511 --branch
<name
>
518 Instead of pointing the newly created HEAD to the branch pointed
519 to by the cloned repository's HEAD, point to
<tt><name
></tt> branch
520 instead. In a non-bare repository, this is the branch that will
525 --upload-pack
<upload-pack
>
528 -u
<upload-pack
>
532 When given, and the repository to clone from is accessed
533 via ssh, this specifies a non-default path for the command
534 run on the other end.
538 --template=
<template_directory
>
542 Specify the directory from which templates will be used;
543 (See the
"TEMPLATE DIRECTORY" section of
<a href=
"git-init.html">git-init(
1)
</a>.)
547 --depth
<depth
>
551 Create a
<em>shallow
</em> clone with a history truncated to the
552 specified number of revisions. A shallow repository has a
553 number of limitations (you cannot clone or fetch from
554 it, nor push from nor into it), but is adequate if you
555 are only interested in the recent history of a large project
556 with a long history, and would want to send in fixes
565 After the clone is created, initialize all submodules within,
566 using their default settings. This is equivalent to running
567 <tt>git submodule update --init --recursive
</tt> immediately after
568 the clone is finished. This option is ignored if the cloned
569 repository does not have a worktree/checkout (i.e. if any of
570 <tt>--no-checkout
</tt>/
<tt>-n
</tt>,
<tt>--bare
</tt>, or
<tt>--mirror
</tt> is given)
578 The (possibly remote) repository to clone from. See the
579 <a href=
"#URLS">URLS
</a> section below for more information on specifying
588 The name of a new directory to clone into. The
"humanish"
589 part of the source repository is used if no directory is
590 explicitly given (
<tt>repo
</tt> for
<tt>/path/to/repo.git
</tt> and
<tt>foo
</tt>
591 for
<tt>host.xz:foo/.git
</tt>). Cloning into an existing directory
592 is only allowed if the directory is empty.
597 <h2 id=
"_git_urls_a_id_urls_a">GIT URLS
<a id=
"URLS"></a></h2>
598 <div class=
"sectionbody">
599 <div class=
"para"><p>In general, URLs contain information about the transport protocol, the
600 address of the remote server, and the path to the repository.
601 Depending on the transport protocol, some of this information may be
603 <div class=
"para"><p>Git natively supports ssh, git, http, https, ftp, ftps, and rsync
604 protocols. The following syntaxes may be used with them:
</p></div>
605 <div class=
"ilist"><ul>
608 ssh://
[user@
]host.xz
[:port
]/path/to/repo.git/
613 git://host.xz
[:port
]/path/to/repo.git/
618 http
[s
]://host.xz
[:port
]/path/to/repo.git/
623 ftp
[s
]://host.xz
[:port
]/path/to/repo.git/
628 rsync://host.xz/path/to/repo.git/
632 <div class=
"para"><p>An alternative scp-like syntax may also be used with the ssh protocol:
</p></div>
633 <div class=
"ilist"><ul>
636 [user@
]host.xz:path/to/repo.git/
640 <div class=
"para"><p>The ssh and git protocols additionally support ~username expansion:
</p></div>
641 <div class=
"ilist"><ul>
644 ssh://
[user@
]host.xz
[:port
]/~
[user
]/path/to/repo.git/
649 git://host.xz
[:port
]/~
[user
]/path/to/repo.git/
654 [user@
]host.xz:/~
[user
]/path/to/repo.git/
658 <div class=
"para"><p>For local respositories, also supported by git natively, the following
659 syntaxes may be used:
</p></div>
660 <div class=
"ilist"><ul>
668 file:///path/to/repo.git/
672 <div class=
"para"><p>These two syntaxes are mostly equivalent, except the former implies
673 --local option.
</p></div>
674 <div class=
"para"><p>When git doesn't know how to handle a certain transport protocol, it
675 attempts to use the
<em>remote-
<transport
></em> remote helper, if one
676 exists. To explicitly request a remote helper, the following syntax
677 may be used:
</p></div>
678 <div class=
"ilist"><ul>
681 <transport
>::
<address
>
685 <div class=
"para"><p>where
<address
> may be a path, a server and path, or an arbitrary
686 URL-like string recognized by the specific remote helper being
687 invoked. See
<a href=
"git-remote-helpers.html">git-remote-helpers(
1)
</a> for details.
</p></div>
688 <div class=
"para"><p>If there are a large number of similarly-named remote repositories and
689 you want to use a different format for them (such that the URLs you
690 use will be rewritten into URLs that work), you can create a
691 configuration section of the form:
</p></div>
692 <div class=
"listingblock">
693 <div class=
"content">
694 <pre><tt> [url
"<actual url base>"]
695 insteadOf =
<other url base
></tt></pre>
697 <div class=
"para"><p>For example, with this:
</p></div>
698 <div class=
"listingblock">
699 <div class=
"content">
700 <pre><tt> [url
"git://git.host.xz/"]
701 insteadOf = host.xz:/path/to/
702 insteadOf = work:
</tt></pre>
704 <div class=
"para"><p>a URL like
"work:repo.git" or like
"host.xz:/path/to/repo.git" will be
705 rewritten in any context that takes a URL to be
"git://git.host.xz/repo.git".
</p></div>
706 <div class=
"para"><p>If you want to rewrite URLs for push only, you can create a
707 configuration section of the form:
</p></div>
708 <div class=
"listingblock">
709 <div class=
"content">
710 <pre><tt> [url
"<actual url base>"]
711 pushInsteadOf =
<other url base
></tt></pre>
713 <div class=
"para"><p>For example, with this:
</p></div>
714 <div class=
"listingblock">
715 <div class=
"content">
716 <pre><tt> [url
"ssh://example.org/"]
717 pushInsteadOf = git://example.org/
</tt></pre>
719 <div class=
"para"><p>a URL like
"git://example.org/path/to/repo.git" will be rewritten to
720 "ssh://example.org/path/to/repo.git" for pushes, but pulls will still
721 use the original URL.
</p></div>
723 <h2 id=
"_examples">Examples
</h2>
724 <div class=
"sectionbody">
725 <div class=
"ilist"><ul>
730 <div class=
"listingblock">
731 <div class=
"content">
732 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-
2.6 my2.6
739 Make a local clone that borrows from the current directory, without checking things out:
741 <div class=
"listingblock">
742 <div class=
"content">
743 <pre><tt>$ git clone -l -s -n . ../copy
745 $ git show-branch
</tt></pre>
750 Clone from upstream while borrowing from an existing local directory:
752 <div class=
"listingblock">
753 <div class=
"content">
754 <pre><tt>$ git clone --reference my2.6 \
755 git://git.kernel.org/pub/scm/.../linux-
2.7 \
757 $ cd my2.7
</tt></pre>
762 Create a bare repository to publish your changes to the public:
764 <div class=
"listingblock">
765 <div class=
"content">
766 <pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
</tt></pre>
771 Create a repository on the kernel.org machine that borrows from Linus:
773 <div class=
"listingblock">
774 <div class=
"content">
775 <pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-
2.6.git \
776 /pub/scm/.../me/subsys-
2.6.git
</tt></pre>
781 <h2 id=
"_author">Author
</h2>
782 <div class=
"sectionbody">
783 <div class=
"para"><p>Written by Linus Torvalds
<torvalds@osdl.org
></p></div>
785 <h2 id=
"_documentation">Documentation
</h2>
786 <div class=
"sectionbody">
787 <div class=
"para"><p>Documentation by Junio C Hamano and the git-list
<git@vger.kernel.org
>.
</p></div>
789 <h2 id=
"_git">GIT
</h2>
790 <div class=
"sectionbody">
791 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
794 <div id=
"footer-text">
795 Last updated
2010-
04-
24 02:
55:
49 UTC