]>
Commit | Line | Data |
---|---|---|
d145144c JH |
1 | git-init(1) |
2 | =========== | |
3 | ||
4 | NAME | |
5 | ---- | |
2de9b711 | 6 | git-init - Create an empty Git repository or reinitialize an existing one |
d145144c JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
b57fb80a | 12 | 'git init' [-q | --quiet] [--bare] [--template=<template_directory>] |
09ffc706 | 13 | [--separate-git-dir <git dir>] |
b57fb80a | 14 | [--shared[=<permissions>]] [directory] |
d145144c JH |
15 | |
16 | ||
9d379f4f NTND |
17 | DESCRIPTION |
18 | ----------- | |
19 | ||
2de9b711 | 20 | This command creates an empty Git repository - basically a `.git` |
9d379f4f NTND |
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 | |
b57fb80a NTND |
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). | |
9d379f4f | 37 | |
d145144c JH |
38 | OPTIONS |
39 | ------- | |
40 | ||
41 | -- | |
42 | ||
3240240f SB |
43 | -q:: |
44 | --quiet:: | |
4576518d JO |
45 | |
46 | Only print error and warning messages, all other output will be suppressed. | |
47 | ||
74d3b23f LR |
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 | ||
d145144c JH |
53 | --template=<template_directory>:: |
54 | ||
d8a8488d SD |
55 | Specify the directory from which templates will be used. (See the "TEMPLATE |
56 | DIRECTORY" section below.) | |
d145144c | 57 | |
b57fb80a NTND |
58 | --separate-git-dir=<git dir>:: |
59 | ||
60 | Instead of initializing the repository where it is supposed to be, | |
2de9b711 TA |
61 | place a filesytem-agnostic Git symbolic link there, pointing to the |
62 | specified path, and initialize a Git repository at the path. The | |
63 | result is Git repository can be separated from working tree. If this | |
b57fb80a NTND |
64 | is reinitialization, the repository will be moved to the specified |
65 | path. | |
66 | ||
0adda936 | 67 | --shared[=(false|true|umask|group|all|world|everybody|0xxx)]:: |
d145144c | 68 | |
2de9b711 | 69 | Specify that the Git repository is to be shared amongst several users. This |
d145144c JH |
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 | |
2de9b711 | 73 | requested permissions. When not specified, Git will use permissions reported |
d145144c JH |
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). | |
098082fb JH |
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. | |
d145144c JH |
89 | |
90 | - 'all' (or 'world' or 'everybody'): Same as 'group', but make the repository | |
91 | readable by all users. | |
92 | ||
098082fb JH |
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. | |
06cbe855 | 99 | |
02ff6250 | 100 | By default, the configuration flag receive.denyNonFastForwards is enabled |
d145144c JH |
101 | in shared repositories, so that you cannot force a non fast-forwarding push |
102 | into it. | |
103 | ||
53d48885 NS |
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 | ||
d145144c JH |
107 | -- |
108 | ||
109 | ||
d8a8488d SD |
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. | |
d145144c JH |
129 | |
130 | EXAMPLES | |
131 | -------- | |
132 | ||
2de9b711 | 133 | Start a new Git repository for an existing code base:: |
d145144c JH |
134 | + |
135 | ---------------- | |
136 | $ cd /path/to/my/codebase | |
b1889c36 JN |
137 | $ git init <1> |
138 | $ git add . <2> | |
d145144c JH |
139 | ---------------- |
140 | + | |
141 | <1> prepare /path/to/my/codebase/.git directory | |
142 | <2> add all existing file to the index | |
143 | ||
d145144c JH |
144 | GIT |
145 | --- | |
9e1f0a85 | 146 | Part of the linkgit:git[1] suite |