Documentation/git-init.txt

   1 git-init(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-init - Create an empty Git repository or reinitialize an existing one
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 `git init` [`-q` | `--quiet`] [`--bare`] [++--template=++__<template-directory>__]
  13           [`--separate-git-dir` _<git-dir>_] [++--object-format=++__<format>__]
  14           [++--ref-format=++__<format>__]
  15           [`-b` _<branch-name>_ | ++--initial-branch=++__<branch-name>__]
  16           [++--shared++[++=++__<permissions>__]] [_<directory>_]
  17
  18
  19 DESCRIPTION
  20 -----------
  21
  22 This command creates an empty Git repository - basically a `.git`
  23 directory with subdirectories for `objects`, `refs/heads`,
  24 `refs/tags`, and template files.  An initial branch without any
  25 commits will be created (see the `--initial-branch` option below
  26 for its name).
  27
  28 If the `$GIT_DIR` environment variable is set then it specifies a path
  29 to use instead of `./.git` for the base of the repository.
  30
  31 If the object storage directory is specified via the
  32 `$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories
  33 are created underneath; otherwise, the default `$GIT_DIR/objects`
  34 directory is used.
  35
  36 Running `git init` in an existing repository is safe. It will not
  37 overwrite things that are already there. The primary reason for
  38 rerunning `git init` is to pick up newly added templates (or to move
  39 the repository to another place if `--separate-git-dir` is given).
  40
  41 OPTIONS
  42 -------
  43
  44 `-q`::
  45 `--quiet`::
  46
  47 Only print error and warning messages; all other output will be suppressed.
  48
  49 `--bare`::
  50
  51 Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
  52 current working directory.
  53
  54 ++--object-format=++__<format>__::
  55
  56 Specify the given object _<format>_ (hash algorithm) for the repository.  The valid
  57 values are `sha1` and (if enabled) `sha256`.  `sha1` is the default.
  58 +
  59 include::object-format-disclaimer.txt[]
  60
  61 ++--ref-format=++__<format>__::
  62
  63 Specify the given ref storage _<format>_ for the repository. The valid values are:
  64 +
  65 include::ref-storage-format.txt[]
  66
  67 ++--template=++__<template-directory>__::
  68
  69 Specify the directory from which templates will be used.  (See the "TEMPLATE
  70 DIRECTORY" section below.)
  71
  72 ++--separate-git-dir=++__<git-dir>__::
  73
  74 Instead of initializing the repository as a directory to either `$GIT_DIR` or
  75 `./.git/`, create a text file there containing the path to the actual
  76 repository.  This file acts as a filesystem-agnostic Git symbolic link to the
  77 repository.
  78 +
  79 If this is a reinitialization, the repository will be moved to the specified path.
  80
  81 `-b` _<branch-name>_::
  82 ++--initial-branch=++__<branch-name>__::
  83
  84 Use _<branch-name>_ for the initial branch in the newly created
  85 repository.  If not specified, fall back to the default name (currently
  86 `master`, but this is subject to change in the future; the name can be
  87 customized via the `init.defaultBranch` configuration variable).
  88
  89 ++--shared++[++=++(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::
  90
  91 Specify that the Git repository is to be shared amongst several users.  This
  92 allows users belonging to the same group to push into that
  93 repository.  When specified, the config variable `core.sharedRepository` is
  94 set so that files and directories under `$GIT_DIR` are created with the
  95 requested permissions.  When not specified, Git will use permissions reported
  96 by `umask`(2).
  97 +
  98 The option can have the following values, defaulting to `group` if no value
  99 is given:
 100 +
 101 --
 102 `umask`::
 103 `false`::
 104
 105 Use permissions reported by `umask`(2). The default, when `--shared` is not
 106 specified.
 107
 108 `group`::
 109 `true`::
 110
 111 Make the repository group-writable, (and `g+sx`, since the git group may not be
 112 the primary group of all users). This is used to loosen the permissions of an
 113 otherwise safe `umask`(2) value. Note that the umask still applies to the other
 114 permission bits (e.g. if umask is `0022`, using `group` will not remove read
 115 privileges from other (non-group) users). See `0xxx` for how to exactly specify
 116 the repository permissions.
 117
 118 `all`::
 119 `world`::
 120 `everybody`::
 121
 122 Same as `group`, but make the repository readable by all users.
 123
 124 _<perm>_::
 125
 126 _<perm>_ is a 3-digit octal number prefixed with `0` and each file
 127 will have mode _<perm>_. _<perm>_ will override users' `umask`(2)
 128 value (and not only loosen permissions as `group` and `all`
 129 do). `0640` will create a repository which is group-readable, but
 130 not group-writable or accessible to others. `0660` will create a repo
 131 that is readable and writable to the current user and group, but
 132 inaccessible to others (directories and executable files get their
 133 `x` bit from the `r` bit for corresponding classes of users).
 134 --
 135
 136 By default, the configuration flag `receive.denyNonFastForwards` is enabled
 137 in shared repositories, so that you cannot force a non fast-forwarding push
 138 into it.
 139
 140 If you provide a _<directory>_, the command is run inside it. If this directory
 141 does not exist, it will be created.
 142
 143 TEMPLATE DIRECTORY
 144 ------------------
 145
 146 Files and directories in the template directory whose name do not start with a
 147 dot will be copied to the `$GIT_DIR` after it is created.
 148
 149 The template directory will be one of the following (in order):
 150
 151  - the argument given with the `--template` option;
 152
 153  - the contents of the `$GIT_TEMPLATE_DIR` environment variable;
 154
 155  - the `init.templateDir` configuration variable; or
 156
 157  - the default template directory: `/usr/share/git-core/templates`.
 158
 159 The default template directory includes some directory structure, suggested
 160 "exclude patterns" (see linkgit:gitignore[5]), and sample hook files.
 161
 162 The sample hooks are all disabled by default. To enable one of the
 163 sample hooks rename it by removing its `.sample` suffix.
 164
 165 See linkgit:githooks[5] for more general info on hook execution.
 166
 167 EXAMPLES
 168 --------
 169
 170 Start a new Git repository for an existing code base::
 171 +
 172 ----------------
 173 $ cd /path/to/my/codebase
 174 $ git init      <1>
 175 $ git add .     <2>
 176 $ git commit    <3>
 177 ----------------
 178 +
 179 <1> Create a `/path/to/my/codebase/.git` directory.
 180 <2> Add all existing files to the index.
 181 <3> Record the pristine state as the first commit in the history.
 182
 183 CONFIGURATION
 184 -------------
 185
 186 include::includes/cmd-config-section-all.txt[]
 187
 188 :git-init:
 189
 190 include::config/init.txt[]
 191
 192 GIT
 193 ---
 194 Part of the linkgit:git[1] suite