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