Documentation/git-clone.txt

   1 git-clone(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-clone - Clones a repository
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
  13           [-o <name>] [-u <upload-pack>] [--reference <repository>]
  14           <repository> [<directory>]
  15
  16 DESCRIPTION
  17 -----------
  18 Clones a repository into a newly created directory.  All remote
  19 branch heads are copied under `$GIT_DIR/refs/heads/`, except
  20 that the remote `master` is also copied to `origin` branch.
  21
  22 In addition, `$GIT_DIR/remotes/origin` file is set up to have
  23 this line:
  24
  25         Pull: master:origin
  26
  27 This is to help the typical workflow of working off of the
  28 remote `master` branch.  Every time `git pull` without argument
  29 is run, the progress on the remote `master` branch is tracked by
  30 copying it into the local `origin` branch, and merged into the
  31 branch you are currently working on.  Remote branches other than
  32 `master` are also added there to be tracked.
  33
  34
  35 OPTIONS
  36 -------
  37 --local::
  38 -l::
  39         When the repository to clone from is on a local machine,
  40         this flag bypasses normal "git aware" transport
  41         mechanism and clones the repository by making a copy of
  42         HEAD and everything under objects and refs directories.
  43         The files under .git/objects/ directory are hardlinked
  44         to save space when possible.
  45
  46 --shared::
  47 -s::
  48         When the repository to clone is on the local machine,
  49         instead of using hard links, automatically setup
  50         .git/objects/info/alternates to share the objects
  51         with the source repository.  The resulting repository
  52         starts out without any object of its own.
  53
  54 --reference <repository>::
  55         If the reference repository is on the local machine
  56         automatically setup .git/objects/info/alternates to
  57         obtain objects from the reference repository.  Using
  58         an already existing repository as an alternate will
  59         require less objects to be copied from the repository
  60         being cloned, reducing network and local storage costs.
  61
  62 --quiet::
  63 -q::
  64         Operate quietly.  This flag is passed to "rsync" and
  65         "git-clone-pack" commands when given.
  66
  67 -n::
  68         No checkout of HEAD is performed after the clone is complete.
  69
  70 --bare::
  71         Make a 'bare' GIT repository.  That is, instead of
  72         creating `<directory>` and placing the administrative
  73         files in `<directory>/.git`, make the `<directory>`
  74         itself the `$GIT_DIR`. This implies `-n` option.  When
  75         this option is used, neither the `origin` branch nor the
  76         default `remotes/origin` file is created.
  77
  78 -o <name>::
  79         Instead of using the branch name 'origin' to keep track
  80         of the upstream repository, use <name> instead.  Note
  81         that the shorthand name stored in `remotes/origin` is
  82         not affected, but the local branch name to pull the
  83         remote `master` branch into is.
  84
  85 --upload-pack <upload-pack>::
  86 -u <upload-pack>::
  87         When given, and the repository to clone from is handled
  88         by 'git-clone-pack', '--exec=<upload-pack>' is passed to
  89         the command to specify non-default path for the command
  90         run on the other end.
  91
  92 --template=<template_directory>::
  93         Specify the directory from which templates will be used;
  94         if unset the templates are taken from the installation
  95         defined default, typically `/usr/share/git-core/templates`.
  96
  97 <repository>::
  98         The (possibly remote) repository to clone from.  It can
  99         be any URL git-fetch supports.
 100
 101 <directory>::
 102         The name of a new directory to clone into.  The "humanish"
 103         part of the source repository is used if no directory is
 104         explicitly given ("repo" for "/path/to/repo.git" and "foo"
 105         for "host.xz:foo/.git").  Cloning into an existing directory
 106         is not allowed.
 107
 108 Examples
 109 --------
 110
 111 Clone from upstream::
 112 +
 113 ------------
 114 $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
 115 $ cd my2.6
 116 $ make
 117 ------------
 118
 119
 120 Make a local clone that borrows from the current directory, without checking things out::
 121 +
 122 ------------
 123 $ git clone -l -s -n . ../copy
 124 $ cd copy
 125 $ git show-branch
 126 ------------
 127
 128
 129 Clone from upstream while borrowing from an existing local directory::
 130 +
 131 ------------
 132 $ git clone --reference my2.6 \
 133         git://git.kernel.org/pub/scm/.../linux-2.7 \
 134         my2.7
 135 $ cd my2.7
 136 ------------
 137
 138
 139 Create a bare repository to publish your changes to the public::
 140 +
 141 ------------
 142 $ git clone --bare -l /home/proj/.git /pub/scm/proj.git
 143 ------------
 144
 145
 146 Create a repository on the kernel.org machine that borrows from Linus::
 147 +
 148 ------------
 149 $ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
 150     /pub/scm/.../me/subsys-2.6.git
 151 ------------
 152
 153
 154 Author
 155 ------
 156 Written by Linus Torvalds <torvalds@osdl.org>
 157
 158
 159 Documentation
 160 --------------
 161 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 162
 163
 164 GIT
 165 ---
 166 Part of the gitlink:git[7] suite
 167