Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-clone(1) |
2 | ============ | |
6ec311da JH |
3 | |
4 | NAME | |
5 | ---- | |
29cf5e12 | 6 | git-clone - Clone a repository into a new directory |
6ec311da JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
b1889c36 | 12 | 'git clone' [--template=<template_directory>] |
bc699afc | 13 | [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror] |
db9bc00e | 14 | [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>] |
e7fed18a | 15 | [--depth <depth>] [--recursive] [--] <repository> [<directory>] |
6ec311da JH |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
4607166d | 19 | |
db9819a4 BF |
20 | Clones a repository into a newly created directory, creates |
21 | remote-tracking branches for each branch in the cloned repository | |
33405be3 JN |
22 | (visible using `git branch -r`), and creates and checks out an |
23 | initial branch that is forked from the cloned repository's | |
24 | currently active branch. | |
4607166d | 25 | |
db9819a4 BF |
26 | After the clone, a plain `git fetch` without arguments will update |
27 | all the remote-tracking branches, and a `git pull` without | |
28 | arguments will in addition merge the remote master branch into the | |
1170e802 | 29 | current master branch, if any. |
4607166d | 30 | |
db9819a4 BF |
31 | This default configuration is achieved by creating references to |
32 | the remote branch heads under `$GIT_DIR/refs/remotes/origin` and | |
33 | by initializing `remote.origin.url` and `remote.origin.fetch` | |
34 | configuration variables. | |
6ec311da | 35 | |
f4bf2184 | 36 | |
6ec311da JH |
37 | OPTIONS |
38 | ------- | |
a2775c2a | 39 | --local:: |
6ec311da JH |
40 | -l:: |
41 | When the repository to clone from is on a local machine, | |
550c66f3 | 42 | this flag bypasses the normal "git aware" transport |
6ec311da JH |
43 | mechanism and clones the repository by making a copy of |
44 | HEAD and everything under objects and refs directories. | |
3d5c418f JH |
45 | The files under `.git/objects/` directory are hardlinked |
46 | to save space when possible. This is now the default when | |
47 | the source repository is specified with `/path/to/repo` | |
48 | syntax, so it essentially is a no-op option. To force | |
49 | copying instead of hardlinking (which may be desirable | |
50 | if you are trying to make a back-up of your repository), | |
51 | but still avoid the usual "git aware" transport | |
52 | mechanism, `--no-hardlinks` can be used. | |
53 | ||
54 | --no-hardlinks:: | |
55 | Optimize the cloning process from a repository on a | |
56 | local filesystem by copying files under `.git/objects` | |
57 | directory. | |
6ec311da | 58 | |
a2775c2a EB |
59 | --shared:: |
60 | -s:: | |
61 | When the repository to clone is on the local machine, | |
4607166d | 62 | instead of using hard links, automatically setup |
550c66f3 | 63 | `.git/objects/info/alternates` to share the objects |
4607166d JH |
64 | with the source repository. The resulting repository |
65 | starts out without any object of its own. | |
84668872 MV |
66 | + |
67 | *NOTE*: this is a possibly dangerous operation; do *not* use | |
68 | it unless you understand what it does. If you clone your | |
2498a1ad BC |
69 | repository using this option and then delete branches (or use any |
70 | other git command that makes any existing commit unreferenced) in the | |
71 | source repository, some objects may become unreferenced (or dangling). | |
550c66f3 | 72 | These objects may be removed by normal git operations (such as `git commit`) |
483bc4f0 JN |
73 | which automatically call `git gc --auto`. (See linkgit:git-gc[1].) |
74 | If these objects are removed and were referenced by the cloned repository, | |
75 | then the cloned repository will become corrupt. | |
13354f53 JK |
76 | + |
77 | Note that running `git repack` without the `-l` option in a repository | |
78 | cloned with `-s` will copy objects from the source repository into a pack | |
79 | in the cloned repository, removing the disk space savings of `clone -s`. | |
80 | It is safe, however, to run `git gc`, which uses the `-l` option by | |
81 | default. | |
82 | + | |
83 | If you want to break the dependency of a repository cloned with `-s` on | |
84 | its source repository, you can simply run `git repack -a` to copy all | |
85 | objects from the source repository into a pack in the cloned repository. | |
a2775c2a | 86 | |
23edecbc | 87 | --reference <repository>:: |
40592376 | 88 | If the reference repository is on the local machine, |
550c66f3 | 89 | automatically setup `.git/objects/info/alternates` to |
23edecbc SP |
90 | obtain objects from the reference repository. Using |
91 | an already existing repository as an alternate will | |
451e5931 | 92 | require fewer objects to be copied from the repository |
23edecbc | 93 | being cloned, reducing network and local storage costs. |
2498a1ad | 94 | + |
550c66f3 | 95 | *NOTE*: see the NOTE for the `--shared` option. |
23edecbc | 96 | |
a2775c2a | 97 | --quiet:: |
6ec311da | 98 | -q:: |
488c3163 TRC |
99 | Operate quietly. Progress is not reported to the standard |
100 | error stream. This flag is also passed to the `rsync' | |
d3296e37 | 101 | command when given. |
6ec311da | 102 | |
21188b1e MV |
103 | --verbose:: |
104 | -v:: | |
5a518ad4 TRC |
105 | Run verbosely. |
106 | ||
107 | --progress:: | |
488c3163 TRC |
108 | Progress status is reported on the standard error stream |
109 | by default when it is attached to a terminal, unless -q | |
110 | is specified. This flag forces progress status even if the | |
111 | standard error stream is not directed to a terminal. | |
21188b1e | 112 | |
fd0368f9 | 113 | --no-checkout:: |
a2775c2a EB |
114 | -n:: |
115 | No checkout of HEAD is performed after the clone is complete. | |
116 | ||
87e80c4b JH |
117 | --bare:: |
118 | Make a 'bare' GIT repository. That is, instead of | |
8a1a120c JH |
119 | creating `<directory>` and placing the administrative |
120 | files in `<directory>/.git`, make the `<directory>` | |
71821351 PB |
121 | itself the `$GIT_DIR`. This obviously implies the `-n` |
122 | because there is nowhere to check out the working tree. | |
123 | Also the branch heads at the remote are copied directly | |
124 | to corresponding local branch heads, without mapping | |
125 | them to `refs/remotes/origin/`. When this option is | |
36566cc0 BF |
126 | used, neither remote-tracking branches nor the related |
127 | configuration variables are created. | |
8a1a120c | 128 | |
bc699afc | 129 | --mirror:: |
550c66f3 | 130 | Set up a mirror of the remote repository. This implies `--bare`. |
bc699afc | 131 | |
ba158a32 | 132 | --origin <name>:: |
e6c310fd | 133 | -o <name>:: |
550c66f3 BG |
134 | Instead of using the remote name `origin` to keep track |
135 | of the upstream repository, use `<name>`. | |
e6c310fd | 136 | |
7a4ee28f JK |
137 | --branch <name>:: |
138 | -b <name>:: | |
139 | Instead of pointing the newly created HEAD to the branch pointed | |
550c66f3 | 140 | to by the cloned repository's HEAD, point to `<name>` branch |
7a4ee28f JK |
141 | instead. In a non-bare repository, this is the branch that will |
142 | be checked out. | |
143 | ||
a2775c2a | 144 | --upload-pack <upload-pack>:: |
6ec311da | 145 | -u <upload-pack>:: |
d3296e37 SH |
146 | When given, and the repository to clone from is accessed |
147 | via ssh, this specifies a non-default path for the command | |
6ec311da JH |
148 | run on the other end. |
149 | ||
a57c8bac JH |
150 | --template=<template_directory>:: |
151 | Specify the directory from which templates will be used; | |
152 | if unset the templates are taken from the installation | |
153 | defined default, typically `/usr/share/git-core/templates`. | |
154 | ||
f496454e | 155 | --depth <depth>:: |
f4bf2184 | 156 | Create a 'shallow' clone with a history truncated to the |
d9d10bb8 | 157 | specified number of revisions. A shallow repository has a |
f4bf2184 JH |
158 | number of limitations (you cannot clone or fetch from |
159 | it, nor push from nor into it), but is adequate if you | |
d9d10bb8 RW |
160 | are only interested in the recent history of a large project |
161 | with a long history, and would want to send in fixes | |
f4bf2184 JH |
162 | as patches. |
163 | ||
e7fed18a JH |
164 | --recursive:: |
165 | After the clone is created, initialize all submodules within, | |
166 | using their default settings. This is equivalent to running | |
550c66f3 | 167 | `git submodule update --init --recursive` immediately after |
e7fed18a JH |
168 | the clone is finished. This option is ignored if the cloned |
169 | repository does not have a worktree/checkout (i.e. if any of | |
170 | `--no-checkout`/`-n`, `--bare`, or `--mirror` is given) | |
171 | ||
6ec311da | 172 | <repository>:: |
37ba0561 AR |
173 | The (possibly remote) repository to clone from. See the |
174 | <<URLS,URLS>> section below for more information on specifying | |
175 | repositories. | |
6ec311da JH |
176 | |
177 | <directory>:: | |
fb6a9f93 | 178 | The name of a new directory to clone into. The "humanish" |
0879aa28 | 179 | part of the source repository is used if no directory is |
550c66f3 BG |
180 | explicitly given (`repo` for `/path/to/repo.git` and `foo` |
181 | for `host.xz:foo/.git`). Cloning into an existing directory | |
ec00d6e0 | 182 | is only allowed if the directory is empty. |
4607166d | 183 | |
347989f4 | 184 | :git-clone: 1 |
37ba0561 AR |
185 | include::urls.txt[] |
186 | ||
1e2ccd3a | 187 | Examples |
2b5f3ed3 | 188 | -------- |
1e2ccd3a JH |
189 | |
190 | Clone from upstream:: | |
191 | + | |
192 | ------------ | |
193 | $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6 | |
194 | $ cd my2.6 | |
195 | $ make | |
196 | ------------ | |
197 | ||
198 | ||
199 | Make a local clone that borrows from the current directory, without checking things out:: | |
200 | + | |
201 | ------------ | |
202 | $ git clone -l -s -n . ../copy | |
a6e3768f | 203 | $ cd ../copy |
1e2ccd3a JH |
204 | $ git show-branch |
205 | ------------ | |
206 | ||
8a1a120c | 207 | |
23edecbc SP |
208 | Clone from upstream while borrowing from an existing local directory:: |
209 | + | |
210 | ------------ | |
211 | $ git clone --reference my2.6 \ | |
212 | git://git.kernel.org/pub/scm/.../linux-2.7 \ | |
213 | my2.7 | |
214 | $ cd my2.7 | |
215 | ------------ | |
216 | ||
217 | ||
87e80c4b | 218 | Create a bare repository to publish your changes to the public:: |
8a1a120c JH |
219 | + |
220 | ------------ | |
87e80c4b | 221 | $ git clone --bare -l /home/proj/.git /pub/scm/proj.git |
8a1a120c JH |
222 | ------------ |
223 | ||
224 | ||
225 | Create a repository on the kernel.org machine that borrows from Linus:: | |
226 | + | |
227 | ------------ | |
87e80c4b | 228 | $ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \ |
8a1a120c JH |
229 | /pub/scm/.../me/subsys-2.6.git |
230 | ------------ | |
231 | ||
232 | ||
6ec311da JH |
233 | Author |
234 | ------ | |
235 | Written by Linus Torvalds <torvalds@osdl.org> | |
236 | ||
1e2ccd3a | 237 | |
6ec311da JH |
238 | Documentation |
239 | -------------- | |
0879aa28 | 240 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. |
6ec311da JH |
241 | |
242 | ||
243 | GIT | |
244 | --- | |
9e1f0a85 | 245 | Part of the linkgit:git[1] suite |