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