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>]
  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 --
  42
  43 -q::
  44 --quiet::
  45
  46 Only print error and warning messages, all other output will be suppressed.
  47
  48 --bare::
  49
  50 Create a bare repository. If GIT_DIR environment is not set, it is set to the
  51 current working directory.
  52
  53 --template=<template_directory>::
  54
  55 Specify the directory from which templates will be used.  (See the "TEMPLATE
  56 DIRECTORY" section below.)
  57
  58 --separate-git-dir=<git dir>::
  59
  60 Instead of initializing the repository where it is supposed to be,
  61 place a filesytem-agnostic git symbolic link there, pointing to the
  62 specified git path, and initialize a git repository at the path. The
  63 result is git repository can be separated from working tree. If this
  64 is reinitialization, the repository will be moved to the specified
  65 path.
  66
  67 --shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
  68
  69 Specify that the git repository is to be shared amongst several users.  This
  70 allows users belonging to the same group to push into that
  71 repository.  When specified, the config variable "core.sharedRepository" is
  72 set so that files and directories under `$GIT_DIR` are created with the
  73 requested permissions.  When not specified, git will use permissions reported
  74 by umask(2).
  75
  76 The option can have the following values, defaulting to 'group' if no value
  77 is given:
  78
  79  - 'umask' (or 'false'): Use permissions reported by umask(2). The default,
  80    when `--shared` is not specified.
  81
  82  - 'group' (or 'true'): Make the repository group-writable, (and g+sx, since
  83    the git group may be not the primary group of all users).
  84    This is used to loosen the permissions of an otherwise safe umask(2) value.
  85    Note that the umask still applies to the other permission bits (e.g. if
  86    umask is '0022', using 'group' will not remove read privileges from other
  87    (non-group) users). See '0xxx' for how to exactly specify the repository
  88    permissions.
  89
  90  - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository
  91    readable by all users.
  92
  93  - '0xxx': '0xxx' is an octal number and each file will have mode '0xxx'.
  94    '0xxx' will override users' umask(2) value (and not only loosen permissions
  95    as 'group' and 'all' does). '0640' will create a repository which is
  96    group-readable, but not group-writable or accessible to others. '0660' will
  97    create a repo that is readable and writable to the current user and group,
  98    but inaccessible to others.
  99
 100 By default, the configuration flag receive.denyNonFastForwards is enabled
 101 in shared repositories, so that you cannot force a non fast-forwarding push
 102 into it.
 103
 104 If you name a (possibly non-existent) directory at the end of the command
 105 line, the command is run inside the directory (possibly after creating it).
 106
 107 --
 108
 109
 110 TEMPLATE DIRECTORY
 111 ------------------
 112
 113 The template directory contains files and directories that will be copied to
 114 the `$GIT_DIR` after it is created.
 115
 116 The template directory used will (in order):
 117
 118  - The argument given with the `--template` option.
 119
 120  - The contents of the `$GIT_TEMPLATE_DIR` environment variable.
 121
 122  - The `init.templatedir` configuration variable.
 123
 124  - The default template directory: `/usr/share/git-core/templates`.
 125
 126 The default template directory includes some directory structure, some
 127 suggested "exclude patterns", and copies of sample "hook" files.
 128 The suggested patterns and hook files are all modifiable and extensible.
 129
 130 EXAMPLES
 131 --------
 132
 133 Start a new git repository for an existing code base::
 134 +
 135 ----------------
 136 $ cd /path/to/my/codebase
 137 $ git init      <1>
 138 $ git add .     <2>
 139 ----------------
 140 +
 141 <1> prepare /path/to/my/codebase/.git directory
 142 <2> add all existing file to the index
 143
 144 GIT
 145 ---
 146 Part of the linkgit:git[1] suite