git-clone.txt

   1 git-clone(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-clone - Clone a repository into a new directory
   7
   8
   9 SYNOPSIS
  10 --------
  11 [synopsis]
  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           [--dissociate] [--separate-git-dir <git-dir>]
  16           [--depth <depth>] [--[no-]single-branch] [--no-tags]
  17           [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
  18           [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
  19           [--filter=<filter-spec>] [--also-filter-submodules]] [--] <repository>
  20           [<directory>]
  21
  22 DESCRIPTION
  23 -----------
  24
  25 Clones a repository into a newly created directory, creates
  26 remote-tracking branches for each branch in the cloned repository
  27 (visible using `git branch --remotes`), and creates and checks out an
  28 initial branch that is forked from the cloned repository's
  29 currently active branch.
  30
  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
  34 current master branch, if any (this is untrue when `--single-branch`
  35 is given; see below).
  36
  37 This default configuration is achieved by creating references to
  38 the remote branch heads under `refs/remotes/origin` and
  39 by initializing `remote.origin.url` and `remote.origin.fetch`
  40 configuration variables.
  41
  42
  43 OPTIONS
  44 -------
  45 `-l`::
  46 `--local`::
  47         When the repository to clone from is on a local machine,
  48         this flag bypasses the normal "Git aware" transport
  49         mechanism and clones the repository by making a copy of
  50         `HEAD` and everything under objects and refs directories.
  51         The files under `.git/objects/` directory are hardlinked
  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
  57 never use the local optimizations).  Specifying `--no-local` will
  58 override the default when `/path/to/repo` is given, using the regular
  59 Git transport instead.
  60 +
  61 If the repository's `$GIT_DIR/objects` has symbolic links or is a
  62 symbolic link, the clone will fail. This is a security measure to
  63 prevent the unintentional copying of files by dereferencing the symbolic
  64 links.
  65 +
  66 This option does not work with repositories owned by other users for security
  67 reasons, and `--no-local` must be specified for the clone to succeed.
  68 +
  69 *NOTE*: this operation can race with concurrent modification to the
  70 source repository, similar to running `cp -r <src> <dst>` while modifying
  71 _<src>_.
  72
  73 `--no-hardlinks`::
  74         Force the cloning process from a repository on a local
  75         filesystem to copy the files under the `.git/objects`
  76         directory instead of using hardlinks. This may be desirable
  77         if you are trying to make a back-up of your repository.
  78
  79 `-s`::
  80 `--shared`::
  81         When the repository to clone is on the local machine,
  82         instead of using hard links, automatically setup
  83         `.git/objects/info/alternates` to share the objects
  84         with the source repository.  The resulting repository
  85         starts out without any object of its own.
  86 +
  87 *NOTE*: this is a possibly dangerous operation; do *not* use
  88 it unless you understand what it does. If you clone your
  89 repository using this option and then delete branches (or use any
  90 other Git command that makes any existing commit unreferenced) in the
  91 source repository, some objects may become unreferenced (or dangling).
  92 These objects may be removed by normal Git operations (such as `git commit`)
  93 which automatically call `git maintenance run --auto`. (See
  94 linkgit:git-maintenance[1].) If these objects are removed and were referenced
  95 by the cloned repository, then the cloned repository will become corrupt.
  96 +
  97 Note that running `git repack` without the `--local` option in a repository
  98 cloned with `--shared` will copy objects from the source repository into a pack
  99 in the cloned repository, removing the disk space savings of `clone --shared`.
 100 It is safe, however, to run `git gc`, which uses the `--local` option by
 101 default.
 102 +
 103 If you want to break the dependency of a repository cloned with `--shared` on
 104 its source repository, you can simply run `git repack -a` to copy all
 105 objects from the source repository into a pack in the cloned repository.
 106
 107 `--reference[-if-able] <repository>`::
 108         If the reference _<repository>_ is on the local machine,
 109         automatically setup `.git/objects/info/alternates` to
 110         obtain objects from the reference _<repository>_.  Using
 111         an already existing repository as an alternate will
 112         require fewer objects to be copied from the repository
 113         being cloned, reducing network and local storage costs.
 114         When using the `--reference-if-able`, a non existing
 115         directory is skipped with a warning instead of aborting
 116         the clone.
 117 +
 118 *NOTE*: see the NOTE for the `--shared` option, and also the
 119 `--dissociate` option.
 120
 121 `--dissociate`::
 122         Borrow the objects from reference repositories specified
 123         with the `--reference` options only to reduce network
 124         transfer, and stop borrowing from them after a clone is made
 125         by making necessary local copies of borrowed objects.  This
 126         option can also be used when cloning locally from a
 127         repository that already borrows objects from another
 128         repository--the new repository will borrow objects from the
 129         same repository, and this option can be used to stop the
 130         borrowing.
 131
 132 `-q`::
 133 `--quiet`::
 134         Operate quietly.  Progress is not reported to the standard
 135         error stream.
 136
 137 `-v`::
 138 `--verbose`::
 139         Run verbosely. Does not affect the reporting of progress status
 140         to the standard error stream.
 141
 142 `--progress`::
 143         Progress status is reported on the standard error stream
 144         by default when it is attached to a terminal, unless `--quiet`
 145         is specified. This flag forces progress status even if the
 146         standard error stream is not directed to a terminal.
 147
 148 `--server-option=<option>`::
 149         Transmit the given string to the server when communicating using
 150         protocol version 2.  The given string must not contain a NUL or LF
 151         character.  The server's handling of server options, including
 152         unknown ones, is server-specific.
 153         When multiple `--server-option=<option>` are given, they are all
 154         sent to the other side in the order listed on the command line.
 155         When no ++--server-option=++__<option>__ is given from the command
 156         line, the values of configuration variable `remote.<name>.serverOption`
 157         are used instead.
 158
 159 `-n`::
 160 `--no-checkout`::
 161         No checkout of `HEAD` is performed after the clone is complete.
 162
 163 `--`[`no-`]`reject-shallow`::
 164         Fail if the source repository is a shallow repository.
 165         The `clone.rejectShallow` configuration variable can be used to
 166         specify the default.
 167
 168 `--bare`::
 169         Make a 'bare' Git repository.  That is, instead of
 170         creating _<directory>_ and placing the administrative
 171         files in `<directory>/.git`, make the _<directory>_
 172         itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
 173         because there is nowhere to check out the working tree.
 174         Also the branch heads at the remote are copied directly
 175         to corresponding local branch heads, without mapping
 176         them to `refs/remotes/origin/`.  When this option is
 177         used, neither remote-tracking branches nor the related
 178         configuration variables are created.
 179
 180 `--sparse`::
 181         Employ a sparse-checkout, with only files in the toplevel
 182         directory initially being present.  The
 183         linkgit:git-sparse-checkout[1] command can be used to grow the
 184         working directory as needed.
 185
 186 `--filter=<filter-spec>`::
 187         Use the partial clone feature and request that the server sends
 188         a subset of reachable objects according to a given object filter.
 189         When using `--filter`, the supplied _<filter-spec>_ is used for
 190         the partial clone filter. For example, `--filter=blob:none` will
 191         filter out all blobs (file contents) until needed by Git. Also,
 192         `--filter=blob:limit=<size>` will filter out all blobs of size
 193         at least _<size>_. For more details on filter specifications, see
 194         the `--filter` option in linkgit:git-rev-list[1].
 195
 196 `--also-filter-submodules`::
 197         Also apply the partial clone filter to any submodules in the repository.
 198         Requires `--filter` and `--recurse-submodules`. This can be turned on by
 199         default by setting the `clone.filterSubmodules` config option.
 200
 201 `--mirror`::
 202         Set up a mirror of the source repository.  This implies `--bare`.
 203         Compared to `--bare`, `--mirror` not only maps local branches of the
 204         source to local branches of the target, it maps all refs (including
 205         remote-tracking branches, notes etc.) and sets up a refspec configuration such
 206         that all these refs are overwritten by a `git remote update` in the
 207         target repository.
 208
 209 `-o` _<name>_::
 210 `--origin` _<name>_::
 211         Instead of using the remote name `origin` to keep track of the upstream
 212         repository, use _<name>_.  Overrides `clone.defaultRemoteName` from the
 213         config.
 214
 215 `-b` _<name>_::
 216 `--branch` _<name>_::
 217         Instead of pointing the newly created `HEAD` to the branch pointed
 218         to by the cloned repository's `HEAD`, point to _<name>_ branch
 219         instead. In a non-bare repository, this is the branch that will
 220         be checked out.
 221         `--branch` can also take tags and detaches the `HEAD` at that commit
 222         in the resulting repository.
 223
 224 `-u` _<upload-pack>_::
 225 `--upload-pack` _<upload-pack>_::
 226         When given, and the repository to clone from is accessed
 227         via ssh, this specifies a non-default path for the command
 228         run on the other end.
 229
 230 `--template=<template-directory>`::
 231         Specify the directory from which templates will be used;
 232         (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
 233
 234 `-c` `<key>=<value>`::
 235 `--config` `<key>=<value>`::
 236         Set a configuration variable in the newly-created repository;
 237         this takes effect immediately after the repository is
 238         initialized, but before the remote history is fetched or any
 239         files checked out.  The _<key>_ is in the same format as expected by
 240         linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
 241         values are given for the same key, each value will be written to
 242         the config file. This makes it safe, for example, to add
 243         additional fetch refspecs to the origin remote.
 244 +
 245 Due to limitations of the current implementation, some configuration
 246 variables do not take effect until after the initial fetch and checkout.
 247 Configuration variables known to not take effect are:
 248 `remote.<name>.mirror` and `remote.<name>.tagOpt`.  Use the
 249 corresponding `--mirror` and `--no-tags` options instead.
 250
 251 `--depth <depth>`::
 252         Create a 'shallow' clone with a history truncated to the
 253         specified number of commits. Implies `--single-branch` unless
 254         `--no-single-branch` is given to fetch the histories near the
 255         tips of all branches. If you want to clone submodules shallowly,
 256         also pass `--shallow-submodules`.
 257
 258 `--shallow-since=<date>`::
 259         Create a shallow clone with a history after the specified time.
 260
 261 `--shallow-exclude=<ref>`::
 262         Create a shallow clone with a history, excluding commits
 263         reachable from a specified remote branch or tag.  This option
 264         can be specified multiple times.
 265
 266 `--[no-]single-branch`::
 267         Clone only the history leading to the tip of a single branch,
 268         either specified by the `--branch` option or the primary
 269         branch remote's `HEAD` points at.
 270         Further fetches into the resulting repository will only update the
 271         remote-tracking branch for the branch this option was used for the
 272         initial cloning.  If the `HEAD` at the remote did not point at any
 273         branch when `--single-branch` clone was made, no remote-tracking
 274         branch is created.
 275
 276 `--no-tags`::
 277         Don't clone any tags, and set
 278         `remote.<remote>.tagOpt=--no-tags` in the config, ensuring
 279         that future `git pull` and `git fetch` operations won't follow
 280         any tags. Subsequent explicit tag fetches will still work,
 281         (see linkgit:git-fetch[1]).
 282 +
 283 Can be used in conjunction with `--single-branch` to clone and
 284 maintain a branch with no references other than a single cloned
 285 branch. This is useful e.g. to maintain minimal clones of the default
 286 branch of some repository for search indexing.
 287
 288 `--recurse-submodules[=<pathspec>]`::
 289         After the clone is created, initialize and clone submodules
 290         within based on the provided _<pathspec>_.  If no `=<pathspec>` is
 291         provided, all submodules are initialized and cloned.
 292         This option can be given multiple times for pathspecs consisting
 293         of multiple entries.  The resulting clone has `submodule.active` set to
 294         the provided pathspec, or "`.`" (meaning all submodules) if no
 295         pathspec is provided.
 296 +
 297 Submodules are initialized and cloned using their default settings. This is
 298 equivalent to running
 299 `git submodule update --init --recursive <pathspec>` immediately after
 300 the clone is finished. This option is ignored if the cloned repository does
 301 not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
 302 or `--mirror` is given)
 303
 304 `--[no-]shallow-submodules`::
 305         All submodules which are cloned will be shallow with a depth of 1.
 306
 307 `--[no-]remote-submodules`::
 308         All submodules which are cloned will use the status of the submodule's
 309         remote-tracking branch to update the submodule, rather than the
 310         superproject's recorded SHA-1. Equivalent to passing `--remote` to
 311         `git submodule update`.
 312
 313 `--separate-git-dir=<git-dir>`::
 314         Instead of placing the cloned repository where it is supposed
 315         to be, place the cloned repository at the specified directory,
 316         then make a filesystem-agnostic Git symbolic link to there.
 317         The result is Git repository can be separated from working
 318         tree.
 319
 320 `--ref-format=<ref-format>`::
 321
 322 Specify the given ref storage format for the repository. The valid values are:
 323 +
 324 include::ref-storage-format.txt[]
 325
 326 `-j` _<n>_::
 327 `--jobs` _<n>_::
 328         The number of submodules fetched at the same time.
 329         Defaults to the `submodule.fetchJobs` option.
 330
 331 _<repository>_::
 332         The (possibly remote) _<repository>_ to clone from.  See the
 333         <<URLS,GIT URLS>> section below for more information on specifying
 334         repositories.
 335
 336 _<directory>_::
 337         The name of a new directory to clone into.  The "humanish"
 338         part of the source repository is used if no _<directory>_ is
 339         explicitly given (`repo` for `/path/to/repo.git` and `foo`
 340         for `host.xz:foo/.git`).  Cloning into an existing directory
 341         is only allowed if the directory is empty.
 342
 343 `--bundle-uri=<uri>`::
 344         Before fetching from the remote, fetch a bundle from the given
 345         _<uri>_ and unbundle the data into the local repository. The refs
 346         in the bundle will be stored under the hidden `refs/bundle/*`
 347         namespace. This option is incompatible with `--depth`,
 348         `--shallow-since`, and `--shallow-exclude`.
 349
 350 :git-clone: 1
 351 include::urls.txt[]
 352
 353 EXAMPLES
 354 --------
 355
 356 * Clone from upstream:
 357 +
 358 ------------
 359 $ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux
 360 $ cd my-linux
 361 $ make
 362 ------------
 363
 364
 365 * Make a local clone that borrows from the current directory, without checking things out:
 366 +
 367 ------------
 368 $ git clone -l -s -n . ../copy
 369 $ cd ../copy
 370 $ git show-branch
 371 ------------
 372
 373
 374 * Clone from upstream while borrowing from an existing local directory:
 375 +
 376 ------------
 377 $ git clone --reference /git/linux.git \
 378         git://git.kernel.org/pub/scm/.../linux.git \
 379         my-linux
 380 $ cd my-linux
 381 ------------
 382
 383
 384 * Create a bare repository to publish your changes to the public:
 385 +
 386 ------------
 387 $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
 388 ------------
 389
 390 * Clone a local repository from a different user:
 391 +
 392 ------------
 393 $ git clone --no-local /home/otheruser/proj.git /pub/scm/proj.git
 394 ------------
 395
 396 CONFIGURATION
 397 -------------
 398
 399 include::includes/cmd-config-section-all.txt[]
 400
 401 include::config/init.txt[]
 402
 403 include::config/clone.txt[]
 404
 405
 406 GIT
 407 ---
 408 Part of the linkgit:git[1] suite