2007-01-11 20:58:10 +00:00
|
|
|
git-init(1)
|
|
|
|
===========
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2013-01-21 19:17:53 +00:00
|
|
|
git-init - Create an empty Git repository or reinitialize an existing one
|
2007-01-11 20:58:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2011-07-02 02:38:26 +00:00
|
|
|
[verse]
|
2011-03-19 15:16:56 +00:00
|
|
|
'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
|
2020-06-24 14:46:31 +00:00
|
|
|
[--separate-git-dir <git dir>] [--object-format=<format>]
|
2020-06-24 14:46:32 +00:00
|
|
|
[-b <branch-name> | --initial-branch=<branch-name>]
|
2011-03-19 15:16:56 +00:00
|
|
|
[--shared[=<permissions>]] [directory]
|
2007-01-11 20:58:10 +00:00
|
|
|
|
|
|
|
|
2011-03-19 15:16:55 +00:00
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
|
2013-01-21 19:17:53 +00:00
|
|
|
This command creates an empty Git repository - basically a `.git`
|
2011-03-19 15:16:55 +00:00
|
|
|
directory with subdirectories for `objects`, `refs/heads`,
|
|
|
|
`refs/tags`, and template files. An initial `HEAD` file that
|
|
|
|
references the HEAD of the master branch is also created.
|
|
|
|
|
|
|
|
If the `$GIT_DIR` environment variable is set then it specifies a path
|
|
|
|
to use instead of `./.git` for the base of the repository.
|
|
|
|
|
|
|
|
If the object storage directory is specified via the
|
|
|
|
`$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories
|
|
|
|
are created underneath - otherwise the default `$GIT_DIR/objects`
|
|
|
|
directory is used.
|
|
|
|
|
|
|
|
Running 'git init' in an existing repository is safe. It will not
|
|
|
|
overwrite things that are already there. The primary reason for
|
2011-03-19 15:16:56 +00:00
|
|
|
rerunning 'git init' is to pick up newly added templates (or to move
|
|
|
|
the repository to another place if --separate-git-dir is given).
|
2011-03-19 15:16:55 +00:00
|
|
|
|
2007-01-11 20:58:10 +00:00
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-q::
|
|
|
|
--quiet::
|
2007-06-07 12:50:29 +00:00
|
|
|
|
2014-08-08 17:29:14 +00:00
|
|
|
Only print error and warning messages; all other output will be suppressed.
|
2007-06-07 12:50:29 +00:00
|
|
|
|
2008-05-28 18:53:57 +00:00
|
|
|
--bare::
|
|
|
|
|
2016-06-07 22:35:07 +00:00
|
|
|
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
|
2008-05-28 18:53:57 +00:00
|
|
|
current working directory.
|
|
|
|
|
2020-02-22 20:17:38 +00:00
|
|
|
--object-format=<format>::
|
|
|
|
|
|
|
|
Specify the given object format (hash algorithm) for the repository. The valid
|
|
|
|
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
|
|
|
|
|
2007-01-11 20:58:10 +00:00
|
|
|
--template=<template_directory>::
|
|
|
|
|
2010-02-16 23:44:46 +00:00
|
|
|
Specify the directory from which templates will be used. (See the "TEMPLATE
|
|
|
|
DIRECTORY" section below.)
|
2007-01-11 20:58:10 +00:00
|
|
|
|
2011-03-19 15:16:56 +00:00
|
|
|
--separate-git-dir=<git dir>::
|
|
|
|
|
2014-08-08 17:29:17 +00:00
|
|
|
Instead of initializing the repository as a directory to either `$GIT_DIR` or
|
|
|
|
`./.git/`, create a text file there containing the path to the actual
|
|
|
|
repository. This file acts as filesystem-agnostic Git symbolic link to the
|
|
|
|
repository.
|
|
|
|
+
|
|
|
|
If this is reinitialization, the repository will be moved to the specified path.
|
2011-03-19 15:16:56 +00:00
|
|
|
|
2020-06-24 14:46:32 +00:00
|
|
|
-b <branch-name::
|
|
|
|
--initial-branch=<branch-name>::
|
|
|
|
|
|
|
|
Use the specified name for the initial branch in the newly created repository.
|
|
|
|
If not specified, fall back to the default name: `master`.
|
|
|
|
|
2010-10-08 17:31:17 +00:00
|
|
|
--shared[=(false|true|umask|group|all|world|everybody|0xxx)]::
|
2007-01-11 20:58:10 +00:00
|
|
|
|
2013-01-21 19:17:53 +00:00
|
|
|
Specify that the Git repository is to be shared amongst several users. This
|
2007-01-11 20:58:10 +00:00
|
|
|
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 `$GIT_DIR` are created with the
|
2013-01-21 19:17:53 +00:00
|
|
|
requested permissions. When not specified, Git will use permissions reported
|
2007-01-11 20:58:10 +00:00
|
|
|
by umask(2).
|
2014-08-08 17:29:15 +00:00
|
|
|
+
|
2007-01-11 20:58:10 +00:00
|
|
|
The option can have the following values, defaulting to 'group' if no value
|
|
|
|
is given:
|
2014-08-08 17:29:15 +00:00
|
|
|
+
|
|
|
|
--
|
|
|
|
'umask' (or 'false')::
|
|
|
|
|
|
|
|
Use permissions reported by umask(2). The default, when `--shared` is not
|
|
|
|
specified.
|
|
|
|
|
|
|
|
'group' (or 'true')::
|
|
|
|
|
|
|
|
Make the repository group-writable, (and g+sx, since the git group may be not
|
|
|
|
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 '0022', using 'group' will not remove read
|
|
|
|
privileges from other (non-group) users). See '0xxx' for how to exactly specify
|
|
|
|
the repository permissions.
|
2007-01-11 20:58:10 +00:00
|
|
|
|
2014-08-08 17:29:15 +00:00
|
|
|
'all' (or 'world' or 'everybody')::
|
|
|
|
|
|
|
|
Same as 'group', but make the repository readable by all users.
|
|
|
|
|
|
|
|
'0xxx'::
|
|
|
|
|
|
|
|
'0xxx' is an octal number and each file will have mode '0xxx'. '0xxx' will
|
|
|
|
override users' umask(2) value (and not only loosen permissions as 'group' and
|
|
|
|
'all' does). '0640' will create a repository which is group-readable, but not
|
|
|
|
group-writable or accessible to others. '0660' will create a repo that is
|
|
|
|
readable and writable to the current user and group, but inaccessible to others.
|
|
|
|
--
|
2008-04-16 08:34:24 +00:00
|
|
|
|
2014-08-08 17:29:14 +00:00
|
|
|
By default, the configuration flag `receive.denyNonFastForwards` is enabled
|
2007-01-11 20:58:10 +00:00
|
|
|
in shared repositories, so that you cannot force a non fast-forwarding push
|
|
|
|
into it.
|
|
|
|
|
2014-08-08 17:29:18 +00:00
|
|
|
If you provide a 'directory', the command is run inside it. If this directory
|
|
|
|
does not exist, it will be created.
|
2009-07-24 21:59:28 +00:00
|
|
|
|
2010-02-16 23:44:46 +00:00
|
|
|
TEMPLATE DIRECTORY
|
|
|
|
------------------
|
|
|
|
|
2017-02-17 23:37:00 +00:00
|
|
|
Files and directories in the template directory whose name do not start with a
|
|
|
|
dot will be copied to the `$GIT_DIR` after it is created.
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2014-08-08 17:29:16 +00:00
|
|
|
The template directory will be one of the following (in order):
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2014-08-08 17:29:16 +00:00
|
|
|
- the argument given with the `--template` option;
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2014-08-08 17:29:16 +00:00
|
|
|
- the contents of the `$GIT_TEMPLATE_DIR` environment variable;
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2015-03-11 20:32:45 +00:00
|
|
|
- the `init.templateDir` configuration variable; or
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2014-08-08 17:29:16 +00:00
|
|
|
- the default template directory: `/usr/share/git-core/templates`.
|
2010-02-16 23:44:46 +00:00
|
|
|
|
2014-08-08 17:29:19 +00:00
|
|
|
The default template directory includes some directory structure, suggested
|
2016-05-04 22:58:09 +00:00
|
|
|
"exclude patterns" (see linkgit:gitignore[5]), and sample hook files.
|
|
|
|
|
2019-01-24 21:44:16 +00:00
|
|
|
The sample hooks are all disabled by default. To enable one of the
|
2016-05-04 22:58:09 +00:00
|
|
|
sample hooks rename it by removing its `.sample` suffix.
|
|
|
|
|
|
|
|
See linkgit:githooks[5] for more general info on hook execution.
|
2007-01-11 20:58:10 +00:00
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
--------
|
|
|
|
|
2013-01-21 19:17:53 +00:00
|
|
|
Start a new Git repository for an existing code base::
|
2007-01-11 20:58:10 +00:00
|
|
|
+
|
|
|
|
----------------
|
|
|
|
$ cd /path/to/my/codebase
|
2008-06-30 06:09:04 +00:00
|
|
|
$ git init <1>
|
|
|
|
$ git add . <2>
|
2014-08-08 17:29:20 +00:00
|
|
|
$ git commit <3>
|
2007-01-11 20:58:10 +00:00
|
|
|
----------------
|
|
|
|
+
|
2014-08-08 17:29:14 +00:00
|
|
|
<1> Create a /path/to/my/codebase/.git directory.
|
|
|
|
<2> Add all existing files to the index.
|
2014-08-08 17:29:20 +00:00
|
|
|
<3> Record the pristine state as the first commit in the history.
|
2007-01-11 20:58:10 +00:00
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|