Documentation/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 [verse]
  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           [--depth <depth>] [--recursive] [--] <repository> [<directory>]
  16
  17 DESCRIPTION
  18 -----------
  19
  20 Clones a repository into a newly created directory, creates
  21 remote-tracking branches for each branch in the cloned repository
  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.
  25
  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
  29 current master branch, if any.
  30
  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.
  35
  36
  37 OPTIONS
  38 -------
  39 --local::
  40 -l::
  41         When the repository to clone from is on a local machine,
  42         this flag bypasses the normal "git aware" transport
  43         mechanism and clones the repository by making a copy of
  44         HEAD and everything under objects and refs directories.
  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.
  58
  59 --shared::
  60 -s::
  61         When the repository to clone is on the local machine,
  62         instead of using hard links, automatically setup
  63         `.git/objects/info/alternates` to share the objects
  64         with the source repository.  The resulting repository
  65         starts out without any object of its own.
  66 +
  67 *NOTE*: this is a possibly dangerous operation; do *not* use
  68 it unless you understand what it does. If you clone your
  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).
  72 These objects may be removed by normal git operations (such as `git commit`)
  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.
  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.
  86
  87 --reference <repository>::
  88         If the reference repository is on the local machine,
  89         automatically setup `.git/objects/info/alternates` to
  90         obtain objects from the reference repository.  Using
  91         an already existing repository as an alternate will
  92         require fewer objects to be copied from the repository
  93         being cloned, reducing network and local storage costs.
  94 +
  95 *NOTE*: see the NOTE for the `--shared` option.
  96
  97 --quiet::
  98 -q::
  99         Operate quietly.  Progress is not reported to the standard
 100         error stream. This flag is also passed to the `rsync'
 101         command when given.
 102
 103 --verbose::
 104 -v::
 105         Progress status is reported on the standard error stream
 106         by default when it is attached to a terminal, unless -q
 107         is specified. This flag forces progress status even if the
 108         standard error stream is not directed to a terminal.
 109
 110 --no-checkout::
 111 -n::
 112         No checkout of HEAD is performed after the clone is complete.
 113
 114 --bare::
 115         Make a 'bare' GIT repository.  That is, instead of
 116         creating `<directory>` and placing the administrative
 117         files in `<directory>/.git`, make the `<directory>`
 118         itself the `$GIT_DIR`. This obviously implies the `-n`
 119         because there is nowhere to check out the working tree.
 120         Also the branch heads at the remote are copied directly
 121         to corresponding local branch heads, without mapping
 122         them to `refs/remotes/origin/`.  When this option is
 123         used, neither remote-tracking branches nor the related
 124         configuration variables are created.
 125
 126 --mirror::
 127         Set up a mirror of the remote repository.  This implies `--bare`.
 128
 129 --origin <name>::
 130 -o <name>::
 131         Instead of using the remote name `origin` to keep track
 132         of the upstream repository, use `<name>`.
 133
 134 --branch <name>::
 135 -b <name>::
 136         Instead of pointing the newly created HEAD to the branch pointed
 137         to by the cloned repository's HEAD, point to `<name>` branch
 138         instead. In a non-bare repository, this is the branch that will
 139         be checked out.
 140
 141 --upload-pack <upload-pack>::
 142 -u <upload-pack>::
 143         When given, and the repository to clone from is accessed
 144         via ssh, this specifies a non-default path for the command
 145         run on the other end.
 146
 147 --template=<template_directory>::
 148         Specify the directory from which templates will be used;
 149         if unset the templates are taken from the installation
 150         defined default, typically `/usr/share/git-core/templates`.
 151
 152 --depth <depth>::
 153         Create a 'shallow' clone with a history truncated to the
 154         specified number of revisions.  A shallow repository has a
 155         number of limitations (you cannot clone or fetch from
 156         it, nor push from nor into it), but is adequate if you
 157         are only interested in the recent history of a large project
 158         with a long history, and would want to send in fixes
 159         as patches.
 160
 161 --recursive::
 162         After the clone is created, initialize all submodules within,
 163         using their default settings. This is equivalent to running
 164         `git submodule update --init --recursive` immediately after
 165         the clone is finished. This option is ignored if the cloned
 166         repository does not have a worktree/checkout (i.e. if any of
 167         `--no-checkout`/`-n`, `--bare`, or `--mirror` is given)
 168
 169 <repository>::
 170         The (possibly remote) repository to clone from.  See the
 171         <<URLS,URLS>> section below for more information on specifying
 172         repositories.
 173
 174 <directory>::
 175         The name of a new directory to clone into.  The "humanish"
 176         part of the source repository is used if no directory is
 177         explicitly given (`repo` for `/path/to/repo.git` and `foo`
 178         for `host.xz:foo/.git`).  Cloning into an existing directory
 179         is only allowed if the directory is empty.
 180
 181 :git-clone: 1
 182 include::urls.txt[]
 183
 184 Examples
 185 --------
 186
 187 Clone from upstream::
 188 +
 189 ------------
 190 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 191 $ cd my2.6
 192 $ make
 193 ------------
 194
 195
 196 Make a local clone that borrows from the current directory, without checking things out::
 197 +
 198 ------------
 199 $ git clone -l -s -n . ../copy
 200 $ cd ../copy
 201 $ git show-branch
 202 ------------
 203
 204
 205 Clone from upstream while borrowing from an existing local directory::
 206 +
 207 ------------
 208 $ git clone --reference my2.6 \
 209         git://git.kernel.org/pub/scm/.../linux-2.7 \
 210         my2.7
 211 $ cd my2.7
 212 ------------
 213
 214
 215 Create a bare repository to publish your changes to the public::
 216 +
 217 ------------
 218 $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
 219 ------------
 220
 221
 222 Create a repository on the kernel.org machine that borrows from Linus::
 223 +
 224 ------------
 225 $ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
 226     /pub/scm/.../me/subsys-2.6.git
 227 ------------
 228
 229
 230 Author
 231 ------
 232 Written by Linus Torvalds <torvalds@osdl.org>
 233
 234
 235 Documentation
 236 --------------
 237 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 238
 239
 240 GIT
 241 ---
 242 Part of the linkgit:git[1] suite