git-clone.txt 8.1 KB
Newer Older
J
Junio C Hamano 已提交
1 2
git-clone(1)
============
3 4 5

NAME
----
6
git-clone - Clone a repository into a new directory
7 8 9 10


SYNOPSIS
--------
11
[verse]
12
'git clone' [--template=<template_directory>]
13
	  [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
14
	  [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
15
	  [--depth <depth>] [--recursive] [--] <repository> [<directory>]
16 17 18

DESCRIPTION
-----------
19

20 21
Clones a repository into a newly created directory, creates
remote-tracking branches for each branch in the cloned repository
22 23 24
(visible using `git branch -r`), and creates and checks out an
initial branch that is forked from the cloned repository's
currently active branch.
25

26 27 28
After the clone, a plain `git fetch` without arguments will update
all the remote-tracking branches, and a `git pull` without
arguments will in addition merge the remote master branch into the
29
current master branch, if any.
30

31
This default configuration is achieved by creating references to
32
the remote branch heads under `refs/remotes/origin` and
33 34
by initializing `remote.origin.url` and `remote.origin.fetch`
configuration variables.
35

36

37 38
OPTIONS
-------
39
--local::
40 41
-l::
	When the repository to clone from is on a local machine,
42
	this flag bypasses the normal "git aware" transport
43 44
	mechanism and clones the repository by making a copy of
	HEAD and everything under objects and refs directories.
45 46 47 48 49 50 51 52 53 54 55 56 57
	The files under `.git/objects/` directory are hardlinked
	to save space when possible.  This is now the default when
	the source repository is specified with `/path/to/repo`
	syntax, so it essentially is a no-op option.  To force
	copying instead of hardlinking (which may be desirable
	if you are trying to make a back-up of your repository),
	but still avoid the usual "git aware" transport
	mechanism, `--no-hardlinks` can be used.

--no-hardlinks::
	Optimize the cloning process from a repository on a
	local filesystem by copying files under `.git/objects`
	directory.
58

59 60 61
--shared::
-s::
	When the repository to clone is on the local machine,
62
	instead of using hard links, automatically setup
63
	`.git/objects/info/alternates` to share the objects
64 65
	with the source repository.  The resulting repository
	starts out without any object of its own.
66 67 68
+
*NOTE*: this is a possibly dangerous operation; do *not* use
it unless you understand what it does. If you clone your
69 70 71
repository using this option and then delete branches (or use any
other git command that makes any existing commit unreferenced) in the
source repository, some objects may become unreferenced (or dangling).
72
These objects may be removed by normal git operations (such as `git commit`)
73 74 75
which automatically call `git gc --auto`. (See linkgit:git-gc[1].)
If these objects are removed and were referenced by the cloned repository,
then the cloned repository will become corrupt.
76 77 78 79 80 81 82 83 84 85
+
Note that running `git repack` without the `-l` option in a repository
cloned with `-s` will copy objects from the source repository into a pack
in the cloned repository, removing the disk space savings of `clone -s`.
It is safe, however, to run `git gc`, which uses the `-l` option by
default.
+
If you want to break the dependency of a repository cloned with `-s` on
its source repository, you can simply run `git repack -a` to copy all
objects from the source repository into a pack in the cloned repository.
86

S
Shawn Pearce 已提交
87
--reference <repository>::
88
	If the reference repository is on the local machine,
89
	automatically setup `.git/objects/info/alternates` to
S
Shawn Pearce 已提交
90 91
	obtain objects from the reference repository.  Using
	an already existing repository as an alternate will
M
Mike Ralphson 已提交
92
	require fewer objects to be copied from the repository
S
Shawn Pearce 已提交
93
	being cloned, reducing network and local storage costs.
94
+
95
*NOTE*: see the NOTE for the `--shared` option.
S
Shawn Pearce 已提交
96

97
--quiet::
98
-q::
99 100
	Operate quietly.  Progress is not reported to the standard
	error stream. This flag is also passed to the `rsync'
101
	command when given.
102

M
Miklos Vajna 已提交
103 104
--verbose::
-v::
105 106
	Run verbosely. Does not affect the reporting of progress status
	to the standard error stream.
107 108

--progress::
109 110 111 112
	Progress status is reported on the standard error stream
	by default when it is attached to a terminal, unless -q
	is specified. This flag forces progress status even if the
	standard error stream is not directed to a terminal.
M
Miklos Vajna 已提交
113

114
--no-checkout::
115 116 117
-n::
	No checkout of HEAD is performed after the clone is complete.

118 119
--bare::
	Make a 'bare' GIT repository.  That is, instead of
J
Junio C Hamano 已提交
120 121
	creating `<directory>` and placing the administrative
	files in `<directory>/.git`, make the `<directory>`
122 123 124 125 126
	itself the `$GIT_DIR`. This obviously implies the `-n`
	because there is nowhere to check out the working tree.
	Also the branch heads at the remote are copied directly
	to corresponding local branch heads, without mapping
	them to `refs/remotes/origin/`.  When this option is
127 128
	used, neither remote-tracking branches nor the related
	configuration variables are created.
J
Junio C Hamano 已提交
129

130
--mirror::
131 132 133 134 135 136
	Set up a mirror of the source repository.  This implies `--bare`.
	Compared to `--bare`, `--mirror` not only maps local branches of the
	source to local branches of the target, it maps all refs (including
	remote branches, notes etc.) and sets up a refspec configuration such
	that all these refs are overwritten by a `git remote update` in the
	target repository.
137

138
--origin <name>::
139
-o <name>::
140 141
	Instead of using the remote name `origin` to keep track
	of the upstream repository, use `<name>`.
142

143 144 145
--branch <name>::
-b <name>::
	Instead of pointing the newly created HEAD to the branch pointed
146
	to by the cloned repository's HEAD, point to `<name>` branch
147 148 149
	instead. In a non-bare repository, this is the branch that will
	be checked out.

150
--upload-pack <upload-pack>::
151
-u <upload-pack>::
152 153
	When given, and the repository to clone from is accessed
	via ssh, this specifies a non-default path for the command
154 155
	run on the other end.

156 157
--template=<template_directory>::
	Specify the directory from which templates will be used;
158
	(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
159

160
--depth <depth>::
161
	Create a 'shallow' clone with a history truncated to the
162
	specified number of revisions.  A shallow repository has a
163 164
	number of limitations (you cannot clone or fetch from
	it, nor push from nor into it), but is adequate if you
165 166
	are only interested in the recent history of a large project
	with a long history, and would want to send in fixes
167 168
	as patches.

169 170 171
--recursive::
	After the clone is created, initialize all submodules within,
	using their default settings. This is equivalent to running
172
	`git submodule update --init --recursive` immediately after
173 174 175 176
	the clone is finished. This option is ignored if the cloned
	repository does not have a worktree/checkout (i.e. if any of
	`--no-checkout`/`-n`, `--bare`, or `--mirror` is given)

177
<repository>::
178 179 180
	The (possibly remote) repository to clone from.  See the
	<<URLS,URLS>> section below for more information on specifying
	repositories.
181 182

<directory>::
183
	The name of a new directory to clone into.  The "humanish"
184
	part of the source repository is used if no directory is
185 186
	explicitly given (`repo` for `/path/to/repo.git` and `foo`
	for `host.xz:foo/.git`).  Cloning into an existing directory
187
	is only allowed if the directory is empty.
188

189
:git-clone: 1
190 191
include::urls.txt[]

J
Junio C Hamano 已提交
192
Examples
S
sean 已提交
193
--------
J
Junio C Hamano 已提交
194

195
* Clone from upstream:
J
Junio C Hamano 已提交
196 197 198 199 200 201 202 203
+
------------
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
$ cd my2.6
$ make
------------


204
* Make a local clone that borrows from the current directory, without checking things out:
J
Junio C Hamano 已提交
205 206 207
+
------------
$ git clone -l -s -n . ../copy
208
$ cd ../copy
J
Junio C Hamano 已提交
209 210 211
$ git show-branch
------------

J
Junio C Hamano 已提交
212

213
* Clone from upstream while borrowing from an existing local directory:
S
Shawn Pearce 已提交
214 215 216 217 218 219 220 221 222
+
------------
$ git clone --reference my2.6 \
	git://git.kernel.org/pub/scm/.../linux-2.7 \
	my2.7
$ cd my2.7
------------


223
* Create a bare repository to publish your changes to the public:
J
Junio C Hamano 已提交
224 225
+
------------
226
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
J
Junio C Hamano 已提交
227 228 229
------------


230
* Create a repository on the kernel.org machine that borrows from Linus:
J
Junio C Hamano 已提交
231 232
+
------------
233
$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
J
Junio C Hamano 已提交
234 235 236 237
    /pub/scm/.../me/subsys-2.6.git
------------


238 239 240 241
Author
------
Written by Linus Torvalds <torvalds@osdl.org>

J
Junio C Hamano 已提交
242

243 244
Documentation
--------------
245
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
246 247 248 249


GIT
---
250
Part of the linkgit:git[1] suite