]>
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>] |
fb1d6dab | 15 | [--dissociate] [--separate-git-dir <git dir>] |
0dab2468 | 16 | [--depth <depth>] [--[no-]single-branch] [--no-tags] |
bc29b0b9 | 17 | [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules] |
4a465443 DS |
18 | [--[no-]remote-submodules] [--jobs <n>] [--sparse] |
19 | [--filter=<filter>] [--] <repository> | |
4c691016 | 20 | [<directory>] |
6ec311da JH |
21 | |
22 | DESCRIPTION | |
23 | ----------- | |
4607166d | 24 | |
db9819a4 BF |
25 | Clones a repository into a newly created directory, creates |
26 | remote-tracking branches for each branch in the cloned repository | |
3711d1cd | 27 | (visible using `git branch --remotes`), and creates and checks out an |
33405be3 JN |
28 | initial branch that is forked from the cloned repository's |
29 | currently active branch. | |
4607166d | 30 | |
db9819a4 BF |
31 | After the clone, a plain `git fetch` without arguments will update |
32 | all the remote-tracking branches, and a `git pull` without | |
33 | arguments will in addition merge the remote master branch into the | |
31b808a0 RT |
34 | current master branch, if any (this is untrue when "--single-branch" |
35 | is given; see below). | |
4607166d | 36 | |
db9819a4 | 37 | This default configuration is achieved by creating references to |
cc1b8d8b | 38 | the remote branch heads under `refs/remotes/origin` and |
db9819a4 BF |
39 | by initializing `remote.origin.url` and `remote.origin.fetch` |
40 | configuration variables. | |
6ec311da | 41 | |
f4bf2184 | 42 | |
6ec311da JH |
43 | OPTIONS |
44 | ------- | |
45 | -l:: | |
bfc8c84e | 46 | --local:: |
6ec311da | 47 | When the repository to clone from is on a local machine, |
2de9b711 | 48 | this flag bypasses the normal "Git aware" transport |
6ec311da JH |
49 | mechanism and clones the repository by making a copy of |
50 | HEAD and everything under objects and refs directories. | |
3d5c418f | 51 | The files under `.git/objects/` directory are hardlinked |
9197a10c JK |
52 | to save space when possible. |
53 | + | |
54 | If the repository is specified as a local path (e.g., `/path/to/repo`), | |
55 | this is the default, and --local is essentially a no-op. If the | |
56 | repository is specified as a URL, then this flag is ignored (and we | |
189260b1 JK |
57 | never use the local optimizations). Specifying `--no-local` will |
58 | override the default when `/path/to/repo` is given, using the regular | |
2de9b711 | 59 | Git transport instead. |
3d5c418f JH |
60 | |
61 | --no-hardlinks:: | |
897e3e45 ALI |
62 | Force the cloning process from a repository on a local |
63 | filesystem to copy the files under the `.git/objects` | |
64 | directory instead of using hardlinks. This may be desirable | |
65 | if you are trying to make a back-up of your repository. | |
6ec311da | 66 | |
a2775c2a | 67 | -s:: |
bfc8c84e | 68 | --shared:: |
a2775c2a | 69 | When the repository to clone is on the local machine, |
4607166d | 70 | instead of using hard links, automatically setup |
550c66f3 | 71 | `.git/objects/info/alternates` to share the objects |
4607166d JH |
72 | with the source repository. The resulting repository |
73 | starts out without any object of its own. | |
84668872 MV |
74 | + |
75 | *NOTE*: this is a possibly dangerous operation; do *not* use | |
76 | it unless you understand what it does. If you clone your | |
2498a1ad | 77 | repository using this option and then delete branches (or use any |
2de9b711 | 78 | other Git command that makes any existing commit unreferenced) in the |
2498a1ad | 79 | source repository, some objects may become unreferenced (or dangling). |
2de9b711 | 80 | These objects may be removed by normal Git operations (such as `git commit`) |
a95ce124 DS |
81 | which automatically call `git maintenance run --auto`. (See |
82 | linkgit:git-maintenance[1].) If these objects are removed and were referenced | |
83 | by the cloned repository, then the cloned repository will become corrupt. | |
13354f53 | 84 | + |
3711d1cd QN |
85 | Note that running `git repack` without the `--local` option in a repository |
86 | cloned with `--shared` will copy objects from the source repository into a pack | |
87 | in the cloned repository, removing the disk space savings of `clone --shared`. | |
88 | It is safe, however, to run `git gc`, which uses the `--local` option by | |
13354f53 JK |
89 | default. |
90 | + | |
3711d1cd | 91 | If you want to break the dependency of a repository cloned with `--shared` on |
13354f53 JK |
92 | its source repository, you can simply run `git repack -a` to copy all |
93 | objects from the source repository into a pack in the cloned repository. | |
a2775c2a | 94 | |
f7415b4d | 95 | --reference[-if-able] <repository>:: |
40592376 | 96 | If the reference repository is on the local machine, |
550c66f3 | 97 | automatically setup `.git/objects/info/alternates` to |
23edecbc SP |
98 | obtain objects from the reference repository. Using |
99 | an already existing repository as an alternate will | |
451e5931 | 100 | require fewer objects to be copied from the repository |
23edecbc | 101 | being cloned, reducing network and local storage costs. |
f7415b4d SB |
102 | When using the `--reference-if-able`, a non existing |
103 | directory is skipped with a warning instead of aborting | |
104 | the clone. | |
2498a1ad | 105 | + |
fb1d6dab JH |
106 | *NOTE*: see the NOTE for the `--shared` option, and also the |
107 | `--dissociate` option. | |
108 | ||
109 | --dissociate:: | |
110 | Borrow the objects from reference repositories specified | |
111 | with the `--reference` options only to reduce network | |
0181681e AR |
112 | transfer, and stop borrowing from them after a clone is made |
113 | by making necessary local copies of borrowed objects. This | |
114 | option can also be used when cloning locally from a | |
115 | repository that already borrows objects from another | |
116 | repository--the new repository will borrow objects from the | |
117 | same repository, and this option can be used to stop the | |
118 | borrowing. | |
23edecbc | 119 | |
6ec311da | 120 | -q:: |
bfc8c84e | 121 | --quiet:: |
488c3163 | 122 | Operate quietly. Progress is not reported to the standard |
0d0bac67 | 123 | error stream. |
6ec311da | 124 | |
21188b1e | 125 | -v:: |
bfc8c84e | 126 | --verbose:: |
c54b74af TRC |
127 | Run verbosely. Does not affect the reporting of progress status |
128 | to the standard error stream. | |
5a518ad4 TRC |
129 | |
130 | --progress:: | |
488c3163 | 131 | Progress status is reported on the standard error stream |
3711d1cd | 132 | by default when it is attached to a terminal, unless `--quiet` |
488c3163 TRC |
133 | is specified. This flag forces progress status even if the |
134 | standard error stream is not directed to a terminal. | |
21188b1e | 135 | |
6e983059 JT |
136 | --server-option=<option>:: |
137 | Transmit the given string to the server when communicating using | |
138 | protocol version 2. The given string must not contain a NUL or LF | |
139 | character. The server's handling of server options, including | |
140 | unknown ones, is server-specific. | |
141 | When multiple `--server-option=<option>` are given, they are all | |
142 | sent to the other side in the order listed on the command line. | |
143 | ||
a2775c2a | 144 | -n:: |
bfc8c84e | 145 | --no-checkout:: |
a2775c2a EB |
146 | No checkout of HEAD is performed after the clone is complete. |
147 | ||
87e80c4b | 148 | --bare:: |
48a8c26c | 149 | Make a 'bare' Git repository. That is, instead of |
8a1a120c JH |
150 | creating `<directory>` and placing the administrative |
151 | files in `<directory>/.git`, make the `<directory>` | |
3711d1cd | 152 | itself the `$GIT_DIR`. This obviously implies the `--no-checkout` |
71821351 PB |
153 | because there is nowhere to check out the working tree. |
154 | Also the branch heads at the remote are copied directly | |
155 | to corresponding local branch heads, without mapping | |
156 | them to `refs/remotes/origin/`. When this option is | |
36566cc0 BF |
157 | used, neither remote-tracking branches nor the related |
158 | configuration variables are created. | |
8a1a120c | 159 | |
d89f09c8 DS |
160 | --sparse:: |
161 | Initialize the sparse-checkout file so the working | |
162 | directory starts with only the files in the root | |
163 | of the repository. The sparse-checkout file can be | |
164 | modified to grow the working directory as needed. | |
165 | ||
4a465443 DS |
166 | --filter=<filter-spec>:: |
167 | Use the partial clone feature and request that the server sends | |
168 | a subset of reachable objects according to a given object filter. | |
169 | When using `--filter`, the supplied `<filter-spec>` is used for | |
170 | the partial clone filter. For example, `--filter=blob:none` will | |
171 | filter out all blobs (file contents) until needed by Git. Also, | |
172 | `--filter=blob:limit=<size>` will filter out all blobs of size | |
173 | at least `<size>`. For more details on filter specifications, see | |
174 | the `--filter` option in linkgit:git-rev-list[1]. | |
175 | ||
bc699afc | 176 | --mirror:: |
6db2103f UKK |
177 | Set up a mirror of the source repository. This implies `--bare`. |
178 | Compared to `--bare`, `--mirror` not only maps local branches of the | |
179 | source to local branches of the target, it maps all refs (including | |
29b9a66f | 180 | remote-tracking branches, notes etc.) and sets up a refspec configuration such |
6db2103f UKK |
181 | that all these refs are overwritten by a `git remote update` in the |
182 | target repository. | |
bc699afc | 183 | |
e6c310fd | 184 | -o <name>:: |
bfc8c84e | 185 | --origin <name>:: |
de9ed3ef SB |
186 | Instead of using the remote name `origin` to keep track of the upstream |
187 | repository, use `<name>`. Overrides `clone.defaultRemoteName` from the | |
188 | config. | |
e6c310fd | 189 | |
7a4ee28f | 190 | -b <name>:: |
bfc8c84e | 191 | --branch <name>:: |
7a4ee28f | 192 | Instead of pointing the newly created HEAD to the branch pointed |
550c66f3 | 193 | to by the cloned repository's HEAD, point to `<name>` branch |
31b808a0 RT |
194 | instead. In a non-bare repository, this is the branch that will |
195 | be checked out. | |
196 | `--branch` can also take tags and detaches the HEAD at that commit | |
197 | in the resulting repository. | |
7a4ee28f | 198 | |
6ec311da | 199 | -u <upload-pack>:: |
bfc8c84e | 200 | --upload-pack <upload-pack>:: |
d3296e37 SH |
201 | When given, and the repository to clone from is accessed |
202 | via ssh, this specifies a non-default path for the command | |
6ec311da JH |
203 | run on the other end. |
204 | ||
a57c8bac JH |
205 | --template=<template_directory>:: |
206 | Specify the directory from which templates will be used; | |
d8a8488d | 207 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) |
a57c8bac | 208 | |
84054f79 | 209 | -c <key>=<value>:: |
bfc8c84e | 210 | --config <key>=<value>:: |
84054f79 JK |
211 | Set a configuration variable in the newly-created repository; |
212 | this takes effect immediately after the repository is | |
213 | initialized, but before the remote history is fetched or any | |
214 | files checked out. The key is in the same format as expected by | |
215 | linkgit:git-config[1] (e.g., `core.eol=true`). If multiple | |
216 | values are given for the same key, each value will be written to | |
217 | the config file. This makes it safe, for example, to add | |
218 | additional fetch refspecs to the origin remote. | |
7eae4a3a SG |
219 | + |
220 | Due to limitations of the current implementation, some configuration | |
221 | variables do not take effect until after the initial fetch and checkout. | |
222 | Configuration variables known to not take effect are: | |
223 | `remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the | |
224 | corresponding `--mirror` and `--no-tags` options instead. | |
84054f79 | 225 | |
f496454e | 226 | --depth <depth>:: |
f4bf2184 | 227 | Create a 'shallow' clone with a history truncated to the |
fc142811 | 228 | specified number of commits. Implies `--single-branch` unless |
28a1b569 | 229 | `--no-single-branch` is given to fetch the histories near the |
18a74a09 JH |
230 | tips of all branches. If you want to clone submodules shallowly, |
231 | also pass `--shallow-submodules`. | |
f4bf2184 | 232 | |
994c2aaf NTND |
233 | --shallow-since=<date>:: |
234 | Create a shallow clone with a history after the specified time. | |
235 | ||
859e5df9 NTND |
236 | --shallow-exclude=<revision>:: |
237 | Create a shallow clone with a history, excluding commits | |
238 | reachable from a specified remote branch or tag. This option | |
239 | can be specified multiple times. | |
240 | ||
0460ed2c | 241 | --[no-]single-branch:: |
3e6e0edd NTND |
242 | Clone only the history leading to the tip of a single branch, |
243 | either specified by the `--branch` option or the primary | |
28a1b569 | 244 | branch remote's `HEAD` points at. |
31b808a0 | 245 | Further fetches into the resulting repository will only update the |
a6d3bde5 | 246 | remote-tracking branch for the branch this option was used for the |
31b808a0 | 247 | initial cloning. If the HEAD at the remote did not point at any |
a6d3bde5 | 248 | branch when `--single-branch` clone was made, no remote-tracking |
31b808a0 | 249 | branch is created. |
3e6e0edd | 250 | |
0dab2468 ÆAB |
251 | --no-tags:: |
252 | Don't clone any tags, and set | |
253 | `remote.<remote>.tagOpt=--no-tags` in the config, ensuring | |
254 | that future `git pull` and `git fetch` operations won't follow | |
255 | any tags. Subsequent explicit tag fetches will still work, | |
256 | (see linkgit:git-fetch[1]). | |
257 | + | |
258 | Can be used in conjunction with `--single-branch` to clone and | |
259 | maintain a branch with no references other than a single cloned | |
260 | branch. This is useful e.g. to maintain minimal clones of the default | |
261 | branch of some repository for search indexing. | |
262 | ||
6069eccd | 263 | --recurse-submodules[=<pathspec>]:: |
bb62e0a9 BW |
264 | After the clone is created, initialize and clone submodules |
265 | within based on the provided pathspec. If no pathspec is | |
266 | provided, all submodules are initialized and cloned. | |
bc29b0b9 SB |
267 | This option can be given multiple times for pathspecs consisting |
268 | of multiple entries. The resulting clone has `submodule.active` set to | |
bb62e0a9 | 269 | the provided pathspec, or "." (meaning all submodules) if no |
bc29b0b9 SB |
270 | pathspec is provided. |
271 | + | |
272 | Submodules are initialized and cloned using their default settings. This is | |
273 | equivalent to running | |
274 | `git submodule update --init --recursive <pathspec>` immediately after | |
275 | the clone is finished. This option is ignored if the cloned repository does | |
276 | not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`, | |
277 | or `--mirror` is given) | |
e7fed18a | 278 | |
d22eb044 SB |
279 | --[no-]shallow-submodules:: |
280 | All submodules which are cloned will be shallow with a depth of 1. | |
281 | ||
4c691016 | 282 | --[no-]remote-submodules:: |
fd5041e1 | 283 | All submodules which are cloned will use the status of the submodule's |
4c691016 | 284 | remote-tracking branch to update the submodule, rather than the |
fd5041e1 | 285 | superproject's recorded SHA-1. Equivalent to passing `--remote` to |
4c691016 BA |
286 | `git submodule update`. |
287 | ||
b57fb80a NTND |
288 | --separate-git-dir=<git dir>:: |
289 | Instead of placing the cloned repository where it is supposed | |
290 | to be, place the cloned repository at the specified directory, | |
5fe8f49b | 291 | then make a filesystem-agnostic Git symbolic link to there. |
2de9b711 | 292 | The result is Git repository can be separated from working |
b57fb80a NTND |
293 | tree. |
294 | ||
72290d6a SB |
295 | -j <n>:: |
296 | --jobs <n>:: | |
297 | The number of submodules fetched at the same time. | |
298 | Defaults to the `submodule.fetchJobs` option. | |
b57fb80a | 299 | |
6ec311da | 300 | <repository>:: |
37ba0561 | 301 | The (possibly remote) repository to clone from. See the |
73364e4f | 302 | <<URLS,GIT URLS>> section below for more information on specifying |
37ba0561 | 303 | repositories. |
6ec311da JH |
304 | |
305 | <directory>:: | |
fb6a9f93 | 306 | The name of a new directory to clone into. The "humanish" |
0879aa28 | 307 | part of the source repository is used if no directory is |
550c66f3 BG |
308 | explicitly given (`repo` for `/path/to/repo.git` and `foo` |
309 | for `host.xz:foo/.git`). Cloning into an existing directory | |
ec00d6e0 | 310 | is only allowed if the directory is empty. |
4607166d | 311 | |
347989f4 | 312 | :git-clone: 1 |
37ba0561 AR |
313 | include::urls.txt[] |
314 | ||
76a8788c | 315 | EXAMPLES |
2b5f3ed3 | 316 | -------- |
1e2ccd3a | 317 | |
47638685 | 318 | * Clone from upstream: |
1e2ccd3a JH |
319 | + |
320 | ------------ | |
283efb01 TK |
321 | $ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux |
322 | $ cd my-linux | |
1e2ccd3a JH |
323 | $ make |
324 | ------------ | |
325 | ||
326 | ||
47638685 | 327 | * Make a local clone that borrows from the current directory, without checking things out: |
1e2ccd3a JH |
328 | + |
329 | ------------ | |
330 | $ git clone -l -s -n . ../copy | |
a6e3768f | 331 | $ cd ../copy |
1e2ccd3a JH |
332 | $ git show-branch |
333 | ------------ | |
334 | ||
8a1a120c | 335 | |
47638685 | 336 | * Clone from upstream while borrowing from an existing local directory: |
23edecbc SP |
337 | + |
338 | ------------ | |
f22a6543 TK |
339 | $ git clone --reference /git/linux.git \ |
340 | git://git.kernel.org/pub/scm/.../linux.git \ | |
341 | my-linux | |
342 | $ cd my-linux | |
23edecbc SP |
343 | ------------ |
344 | ||
345 | ||
47638685 | 346 | * Create a bare repository to publish your changes to the public: |
8a1a120c JH |
347 | + |
348 | ------------ | |
87e80c4b | 349 | $ git clone --bare -l /home/proj/.git /pub/scm/proj.git |
8a1a120c JH |
350 | ------------ |
351 | ||
352 | ||
6ec311da JH |
353 | GIT |
354 | --- | |
9e1f0a85 | 355 | Part of the linkgit:git[1] suite |