{
    "mode": "man",
    "parameter": "git-init",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/git-init/1/json",
    "generated": "2026-11-08T13:44:15Z",
    "synopsis": "git init [-q | --quiet] [--bare] [--template=<template-directory>]\n[--separate-git-dir <git-dir>] [--object-format=<format>]\n[-b <branch-name> | --initial-branch=<branch-name>]\n[--shared[=<permissions>]] [<directory>]",
    "sections": {
        "NAME": {
            "content": "git-init - Create an empty Git repository or reinitialize an existing one\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "git init [-q | --quiet] [--bare] [--template=<template-directory>]\n[--separate-git-dir <git-dir>] [--object-format=<format>]\n[-b <branch-name> | --initial-branch=<branch-name>]\n[--shared[=<permissions>]] [<directory>]\n\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "This command creates an empty Git repository - basically a .git directory with subdirectories\nfor objects, refs/heads, refs/tags, and template files. An initial branch without any commits\nwill be created (see the --initial-branch option below for its name).\n\nIf the $GITDIR environment variable is set then it specifies a path to use instead of ./.git\nfor the base of the repository.\n\nIf the object storage directory is specified via the $GITOBJECTDIRECTORY environment\nvariable then the sha1 directories are created underneath; otherwise, the default\n$GITDIR/objects directory is used.\n\nRunning git init in an existing repository is safe. It will not overwrite things that are\nalready there. The primary reason for rerunning git init is to pick up newly added templates\n(or to move the repository to another place if --separate-git-dir is given).\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-q, --quiet",
                    "content": "Only print error and warning messages; all other output will be suppressed.\n",
                    "flag": "-q",
                    "long": "--quiet"
                },
                {
                    "name": "--bare",
                    "content": "Create a bare repository. If GITDIR environment is not set, it is set to the current\nworking directory.\n\n--object-format=<format>\nSpecify the given object format (hash algorithm) for the repository. The valid values are\nsha1 and (if enabled) sha256.  sha1 is the default.\n\nNote: At present, there is no interoperability between SHA-256 repositories and SHA-1\nrepositories.\n\nHistorically, we warned that SHA-256 repositories may later need backward incompatible\nchanges when we introduce such interoperability features. Today, we only expect compatible\nchanges. Furthermore, if such changes prove to be necessary, it can be expected that SHA-256\nrepositories created with today’s Git will be usable by future versions of Git without data\nloss.\n\n--template=<template-directory>\nSpecify the directory from which templates will be used. (See the \"TEMPLATE DIRECTORY\"\nsection below.)\n\n--separate-git-dir=<git-dir>\nInstead of initializing the repository as a directory to either $GITDIR or ./.git/,\ncreate a text file there containing the path to the actual repository. This file acts as\na filesystem-agnostic Git symbolic link to the repository.\n\nIf this is a reinitialization, the repository will be moved to the specified path.\n\n-b <branch-name>, --initial-branch=<branch-name>\nUse the specified name for the initial branch in the newly created repository. If not\nspecified, fall back to the default name (currently master, but this is subject to change\nin the future; the name can be customized via the init.defaultBranch configuration\nvariable).\n\n--shared[=(false|true|umask|group|all|world|everybody|<perm>)]\nSpecify that the Git repository is to be shared amongst several users. This allows users\nbelonging to the same group to push into that repository. When specified, the config\nvariable \"core.sharedRepository\" is set so that files and directories under $GITDIR are\ncreated with the requested permissions. When not specified, Git will use permissions\nreported by umask(2).\n\nThe option can have the following values, defaulting to group if no value is given:\n\numask (or false)\nUse permissions reported by umask(2). The default, when --shared is not specified.\n\ngroup (or true)\nMake the repository group-writable, (and g+sx, since the git group may not be the\nprimary group of all users). This is used to loosen the permissions of an otherwise\nsafe umask(2) value. Note that the umask still applies to the other permission bits\n(e.g. if umask is 0022, using group will not remove read privileges from other\n(non-group) users). See 0xxx for how to exactly specify the repository permissions.\n\nall (or world or everybody)\nSame as group, but make the repository readable by all users.\n\n<perm>\n<perm> is a 3-digit octal number prefixed with ‘0` and each file will have mode\n<perm>.  <perm> will override users’ umask(2) value (and not only loosen permissions\nas group and all do).  0640 will create a repository which is group-readable, but not\ngroup-writable or accessible to others.  0660 will create a repo that is readable and\nwritable to the current user and group, but inaccessible to others (directories and\nexecutable files get their x bit from the r bit for corresponding classes of users).\n\nBy default, the configuration flag receive.denyNonFastForwards is enabled in shared\nrepositories, so that you cannot force a non fast-forwarding push into it.\n\nIf you provide a directory, the command is run inside it. If this directory does not exist,\nit will be created.\n",
                    "long": "--bare"
                }
            ]
        },
        "TEMPLATE DIRECTORY": {
            "content": "Files and directories in the template directory whose name do not start with a dot will be\ncopied to the $GITDIR after it is created.\n\nThe template directory will be one of the following (in order):\n\n•   the argument given with the --template option;\n\n•   the contents of the $GITTEMPLATEDIR environment variable;\n\n•   the init.templateDir configuration variable; or\n\n•   the default template directory: /usr/share/git-core/templates.\n\nThe default template directory includes some directory structure, suggested \"exclude\npatterns\" (see gitignore(5)), and sample hook files.\n\nThe sample hooks are all disabled by default. To enable one of the sample hooks rename it by\nremoving its .sample suffix.\n\nSee githooks(5) for more general info on hook execution.\n",
            "subsections": []
        },
        "EXAMPLES": {
            "content": "Start a new Git repository for an existing code base\n\n$ cd /path/to/my/codebase\n$ git init      (1)\n$ git add .     (2)\n$ git commit    (3)\n\n1. Create a /path/to/my/codebase/.git directory.\n2. Add all existing files to the index.\n3. Record the pristine state as the first commit in the history.\n",
            "subsections": []
        },
        "CONFIGURATION": {
            "content": "Everything below this line in this section is selectively included from the git-config(1)\ndocumentation. The content is the same as what’s found there:\n\ninit.templateDir\nSpecify the directory from which templates will be copied. (See the \"TEMPLATE DIRECTORY\"\nsection of git-init(1).)\n\ninit.defaultBranch\nAllows overriding the default branch name e.g. when initializing a new repository.\n",
            "subsections": []
        },
        "GIT": {
            "content": "Part of the git(1) suite\n\nGit 2.43.0                                   07/02/2025                                  GIT-INIT(1)",
            "subsections": []
        }
    },
    "summary": "git-init - Create an empty Git repository or reinitialize an existing one",
    "flags": [
        {
            "flag": "-q",
            "long": "--quiet",
            "arg": null,
            "description": "Only print error and warning messages; all other output will be suppressed."
        },
        {
            "flag": "",
            "long": "--bare",
            "arg": null,
            "description": "Create a bare repository. If GITDIR environment is not set, it is set to the current working directory. --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. Note: At present, there is no interoperability between SHA-256 repositories and SHA-1 repositories. 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’s Git will be usable by future versions of Git without data loss. --template=<template-directory> Specify the directory from which templates will be used. (See the \"TEMPLATE DIRECTORY\" section below.) --separate-git-dir=<git-dir> Instead of initializing the repository as a directory to either $GITDIR or ./.git/, 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. If this is a reinitialization, the repository will be moved to the specified path. -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 (currently master, but this is subject to change in the future; the name can be customized via the init.defaultBranch configuration variable). --shared[=(false|true|umask|group|all|world|everybody|<perm>)] 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 $GITDIR are created with the requested permissions. When not specified, Git will use permissions reported by umask(2). The option can have the following values, defaulting to group if no value is given: 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 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 0022, using group will not remove read privileges from other (non-group) users). See 0xxx for how to exactly specify the repository permissions. all (or world or everybody) Same as group, but make the repository readable by all users. <perm> <perm> is a 3-digit octal number prefixed with ‘0` and each file will have mode <perm>. <perm> will override users’ umask(2) value (and not only loosen permissions as group and all do). 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 (directories and executable files get their x bit from the r bit for corresponding classes of users). By default, the configuration flag receive.denyNonFastForwards is enabled in shared repositories, so that you cannot force a non fast-forwarding push into it. If you provide a directory, the command is run inside it. If this directory does not exist, it will be created."
        }
    ],
    "examples": [
        "Start a new Git repository for an existing code base",
        "$ cd /path/to/my/codebase",
        "$ git init      (1)",
        "$ git add .     (2)",
        "$ git commit    (3)",
        "1. Create a /path/to/my/codebase/.git directory.",
        "2. Add all existing files to the index.",
        "3. Record the pristine state as the first commit in the history."
    ],
    "see_also": [],
    "tldr": {
        "source": "official",
        "description": "Initialize a new local Git repository.",
        "examples": [
            {
                "description": "Initialize a new local repository",
                "command": "git init"
            },
            {
                "description": "Initialize a repository with the specified name for the initial branch",
                "command": "git init {{-b|--initial-branch}} {{branch_name}}"
            },
            {
                "description": "Initialize a repository using SHA256 for object hashes (requires Git version 2.29+)",
                "command": "git init --object-format sha256"
            },
            {
                "description": "Initialize a barebones repository, suitable for use as a remote over SSH",
                "command": "git init --bare"
            }
        ]
    }
}