| blob | e94a2bf946378838537ad3d0785c4ebd9b89d03c |
1 '\" t
2 .\" Title: git-init
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2024-03-11
6 .\" Manual: Git Manual
7 .\" Source: Git 2.44.0.191.g945115026a
8 .\" Language: English
9 .\"
10 .TH "GIT\-INIT" "1" "2024\-03\-11" "Git 2\&.44\&.0\&.191\&.g945115" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-init \- Create an empty Git repository or reinitialize an existing one
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit init\fR [\-q | \-\-quiet] [\-\-bare] [\-\-template=<template\-directory>]
36 [\-\-separate\-git\-dir <git\-dir>] [\-\-object\-format=<format>]
37 [\-\-ref\-format=<format>]
38 [\-b <branch\-name> | \-\-initial\-branch=<branch\-name>]
39 [\-\-shared[=<permissions>]] [<directory>]
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 This command creates an empty Git repository \- basically a \fB\&.git\fR directory with subdirectories for \fBobjects\fR, \fBrefs/heads\fR, \fBrefs/tags\fR, and template files\&. An initial branch without any commits will be created (see the \fB\-\-initial\-branch\fR option below for its name)\&.
45 .sp
46 If the \fB$GIT_DIR\fR environment variable is set then it specifies a path to use instead of \fB\&./\&.git\fR for the base of the repository\&.
47 .sp
48 If the object storage directory is specified via the \fB$GIT_OBJECT_DIRECTORY\fR environment variable then the sha1 directories are created underneath; otherwise, the default \fB$GIT_DIR/objects\fR directory is used\&.
49 .sp
50 Running \fIgit init\fR in an existing repository is safe\&. It will not overwrite things that are already there\&. The primary reason for rerunning \fIgit init\fR is to pick up newly added templates (or to move the repository to another place if \-\-separate\-git\-dir is given)\&.
51 .SH "OPTIONS"
52 .PP
53 \-q, \-\-quiet
54 .RS 4
55 Only print error and warning messages; all other output will be suppressed\&.
56 .RE
57 .PP
58 \-\-bare
59 .RS 4
60 Create a bare repository\&. If
61 \fBGIT_DIR\fR
62 environment is not set, it is set to the current working directory\&.
63 .RE
64 .PP
65 \-\-object\-format=<format>
66 .RS 4
67 Specify the given object format (hash algorithm) for the repository\&. The valid values are
68 \fIsha1\fR
69 and (if enabled)
70 \fIsha256\fR\&.
71 \fIsha1\fR
72 is the default\&.
73 .sp
74 Note: At present, there is no interoperability between SHA\-256 repositories and SHA\-1 repositories\&.
75 .RE
76 .sp
77 Historically, we warned that SHA\-256 repositories may later need backward incompatible changes when we introduce such interoperability features\&. Today, we only expect compatible changes\&. Furthermore, if such changes prove to be necessary, it can be expected that SHA\-256 repositories created with today\(cqs Git will be usable by future versions of Git without data loss\&.
78 .PP
79 \-\-ref\-format=<format>
80 .RS 4
81 Specify the given ref storage format for the repository\&. The valid values are:
82 .sp
83 .RS 4
84 .ie n \{\
85 \h'-04'\(bu\h'+03'\c
86 .\}
87 .el \{\
88 .sp -1
89 .IP \(bu 2.3
90 .\}
91 \fBfiles\fR
92 for loose files with packed\-refs\&. This is the default\&.
93 .RE
94 .sp
95 .RS 4
96 .ie n \{\
97 \h'-04'\(bu\h'+03'\c
98 .\}
99 .el \{\
100 .sp -1
101 .IP \(bu 2.3
102 .\}
103 \fBreftable\fR
104 for the reftable format\&. This format is experimental and its internals are subject to change\&.
105 .RE
106 .RE
107 .PP
108 \-\-template=<template\-directory>
109 .RS 4
110 Specify the directory from which templates will be used\&. (See the "TEMPLATE DIRECTORY" section below\&.)
111 .RE
112 .PP
113 \-\-separate\-git\-dir=<git\-dir>
114 .RS 4
115 Instead of initializing the repository as a directory to either
116 \fB$GIT_DIR\fR
117 or
118 \fB\&./\&.git/\fR, create a text file there containing the path to the actual repository\&. This file acts as a filesystem\-agnostic Git symbolic link to the repository\&.
119 .sp
120 If this is a reinitialization, the repository will be moved to the specified path\&.
121 .RE
122 .PP
123 \-b <branch\-name>, \-\-initial\-branch=<branch\-name>
124 .RS 4
125 Use the specified name for the initial branch in the newly created repository\&. If not specified, fall back to the default name (currently
126 \fBmaster\fR, but this is subject to change in the future; the name can be customized via the
127 \fBinit\&.defaultBranch\fR
128 configuration variable)\&.
129 .RE
130 .PP
131 \-\-shared[=(false|true|umask|group|all|world|everybody|<perm>)]
132 .RS 4
133 Specify that the Git repository is to be shared amongst several users\&. This allows users belonging to the same group to push into that repository\&. When specified, the config variable "core\&.sharedRepository" is set so that files and directories under
134 \fB$GIT_DIR\fR
135 are created with the requested permissions\&. When not specified, Git will use permissions reported by umask(2)\&.
136 .sp
137 The option can have the following values, defaulting to
138 \fIgroup\fR
139 if no value is given:
140 .PP
141 \fIumask\fR (or \fIfalse\fR)
142 .RS 4
143 Use permissions reported by umask(2)\&. The default, when
144 \fB\-\-shared\fR
145 is not specified\&.
146 .RE
147 .PP
148 \fIgroup\fR (or \fItrue\fR)
149 .RS 4
150 Make the repository group\-writable, (and g+sx, since the git group may not be the primary group of all users)\&. This is used to loosen the permissions of an otherwise safe umask(2) value\&. Note that the umask still applies to the other permission bits (e\&.g\&. if umask is
151 \fI0022\fR, using
152 \fIgroup\fR
153 will not remove read privileges from other (non\-group) users)\&. See
154 \fI0xxx\fR
155 for how to exactly specify the repository permissions\&.
156 .RE
157 .PP
158 \fIall\fR (or \fIworld\fR or \fIeverybody\fR)
159 .RS 4
160 Same as
161 \fIgroup\fR, but make the repository readable by all users\&.
162 .RE
163 .PP
164 \fI<perm>\fR
165 .RS 4
166 \fI<perm>\fR
167 is a 3\-digit octal number prefixed with \(oq0` and each file will have mode
168 \fI<perm>\fR\&.
169 \fI<perm>\fR
170 will override users\(cq umask(2) value (and not only loosen permissions as
171 \fIgroup\fR
172 and
173 \fIall\fR
174 do)\&.
175 \fI0640\fR
176 will create a repository which is group\-readable, but not group\-writable or accessible to others\&.
177 \fI0660\fR
178 will create a repo that is readable and writable to the current user and group, but inaccessible to others (directories and executable files get their
179 \fBx\fR
180 bit from the
181 \fBr\fR
182 bit for corresponding classes of users)\&.
183 .RE
184 .RE
185 .sp
186 By default, the configuration flag \fBreceive\&.denyNonFastForwards\fR is enabled in shared repositories, so that you cannot force a non fast\-forwarding push into it\&.
187 .sp
188 If you provide a \fIdirectory\fR, the command is run inside it\&. If this directory does not exist, it will be created\&.
189 .SH "TEMPLATE DIRECTORY"
190 .sp
191 Files and directories in the template directory whose name do not start with a dot will be copied to the \fB$GIT_DIR\fR after it is created\&.
192 .sp
193 The template directory will be one of the following (in order):
194 .sp
195 .RS 4
196 .ie n \{\
197 \h'-04'\(bu\h'+03'\c
198 .\}
199 .el \{\
200 .sp -1
201 .IP \(bu 2.3
202 .\}
203 the argument given with the
204 \fB\-\-template\fR
205 option;
206 .RE
207 .sp
208 .RS 4
209 .ie n \{\
210 \h'-04'\(bu\h'+03'\c
211 .\}
212 .el \{\
213 .sp -1
214 .IP \(bu 2.3
215 .\}
216 the contents of the
217 \fB$GIT_TEMPLATE_DIR\fR
218 environment variable;
219 .RE
220 .sp
221 .RS 4
222 .ie n \{\
223 \h'-04'\(bu\h'+03'\c
224 .\}
225 .el \{\
226 .sp -1
227 .IP \(bu 2.3
228 .\}
229 the
230 \fBinit\&.templateDir\fR
231 configuration variable; or
232 .RE
233 .sp
234 .RS 4
235 .ie n \{\
236 \h'-04'\(bu\h'+03'\c
237 .\}
238 .el \{\
239 .sp -1
240 .IP \(bu 2.3
241 .\}
242 the default template directory:
243 \fB/usr/share/git\-core/templates\fR\&.
244 .RE
245 .sp
246 The default template directory includes some directory structure, suggested "exclude patterns" (see \fBgitignore\fR(5)), and sample hook files\&.
247 .sp
248 The sample hooks are all disabled by default\&. To enable one of the sample hooks rename it by removing its \fB\&.sample\fR suffix\&.
249 .sp
250 See \fBgithooks\fR(5) for more general info on hook execution\&.
251 .SH "EXAMPLES"
252 .PP
253 Start a new Git repository for an existing code base
254 .RS 4
255 .sp
256 .if n \{\
257 .RS 4
258 .\}
259 .nf
260 $ cd /path/to/my/codebase
261 $ git init \fB(1)\fR
262 $ git add \&. \fB(2)\fR
263 $ git commit \fB(3)\fR
264 .fi
265 .if n \{\
266 .RE
267 .\}
268 .sp
269 .TS
270 tab(:);
271 r lw(\n(.lu*75u/100u).
272 \fB1.\fR\h'-2n':T{
273 Create a /path/to/my/codebase/\&.git directory\&.
274 T}
275 \fB2.\fR\h'-2n':T{
276 Add all existing files to the index\&.
277 T}
278 \fB3.\fR\h'-2n':T{
279 Record the pristine state as the first commit in the history\&.
280 T}
281 .TE
282 .RE
283 .SH "CONFIGURATION"
284 .sp
285 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
286 .PP
287 init\&.templateDir
288 .RS 4
289 Specify the directory from which templates will be copied\&. (See the "TEMPLATE DIRECTORY" section of
290 \fBgit-init\fR(1)\&.)
291 .RE
292 .PP
293 init\&.defaultBranch
294 .RS 4
295 Allows overriding the default branch name e\&.g\&. when initializing a new repository\&.
296 .RE
297 .SH "GIT"
298 .sp
299 Part of the \fBgit\fR(1) suite