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