{
    "content": [
        {
            "type": "text",
            "text": "# GIT-CLONE (info)\n\n## NAME\n\ngit-clone - Clone a repository into a new directory\n\n## SYNOPSIS\n\ngit clone [--template=<templatedirectory>]\n[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n[--dissociate] [--separate-git-dir <git dir>]\n[--depth <depth>] [--[no-]single-branch] [--no-tags]\n[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n[--filter=<filter>] [--] <repository>\n[<directory>]\n\n## DESCRIPTION\n\nClones a repository into a newly created directory, creates\nremote-tracking branches for each branch in the cloned repository\n(visible using git branch --remotes), and creates and checks out an\ninitial branch that is forked from the cloned repository's currently\nactive branch.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (17 subsections)\n- **GIT URLS**\n- **EXAMPLES**\n- **GIT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "GIT-CLONE",
        "section": "",
        "mode": "info",
        "summary": "git-clone - Clone a repository into a new directory",
        "synopsis": "git clone [--template=<templatedirectory>]\n[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n[--dissociate] [--separate-git-dir <git dir>]\n[--depth <depth>] [--[no-]single-branch] [--no-tags]\n[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n[--filter=<filter>] [--] <repository>\n[<directory>]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-l",
                "long": "--local",
                "arg": null,
                "description": "When the repository to clone from is on a local machine, this flag bypasses the normal \"Git aware\" transport mechanism and clones the repository by making a copy of HEAD and everything under objects and refs directories. The files under .git/objects/ directory are hardlinked to save space when possible. If the repository is specified as a local path (e.g., /path/to/repo), this is the default, and --local is essentially a no-op. If the repository is specified as a URL, then this flag is ignored (and we never use the local optimizations). Specifying --no-local will override the default when /path/to/repo is given, using the regular Git transport instead. NOTE: this operation can race with concurrent modification to the source repository, similar to running cp -r src dst while modifying src."
            },
            {
                "flag": "",
                "long": "--no-hardlinks",
                "arg": null,
                "description": "Force the cloning process from a repository on a local filesystem to copy the files under the .git/objects directory instead of using hardlinks. This may be desirable if you are trying to make a back-up of your repository."
            },
            {
                "flag": "-s",
                "long": "--shared",
                "arg": null,
                "description": "When the repository to clone is on the local machine, instead of using hard links, automatically setup .git/objects/info/alternates to share the objects with the source repository. The resulting repository starts out without any object of its own. NOTE: this is a possibly dangerous operation; do not use it unless you understand what it does. If you clone your repository using this option and then delete branches (or use any other Git command that makes any existing commit unreferenced) in the source repository, some objects may become unreferenced (or dangling). These objects may be removed by normal Git operations (such as git commit) which automatically call git maintenance run --auto. (See git-maintenance(1).) If these objects are removed and were referenced by the cloned repository, then the cloned repository will become corrupt. Note that running git repack without the --local option in a repository cloned with --shared will copy objects from the source repository into a pack in the cloned repository, removing the disk space savings of clone --shared. It is safe, however, to run git gc, which uses the --local option by default. If you want to break the dependency of a repository cloned with --shared on its source repository, you can simply run git repack -a to copy all objects from the source repository into a pack in the cloned repository. --reference[-if-able] <repository> If the reference repository is on the local machine, automatically setup .git/objects/info/alternates to obtain objects from the reference repository. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs. When using the --reference-if-able, a non existing directory is skipped with a warning instead of aborting the clone. NOTE: see the NOTE for the --shared option, and also the --dissociate option."
            },
            {
                "flag": "",
                "long": "--dissociate",
                "arg": null,
                "description": "Borrow the objects from reference repositories specified with the --reference options only to reduce network transfer, and stop borrowing from them after a clone is made by making necessary local copies of borrowed objects. This option can also be used when cloning locally from a repository that already borrows objects from another repository--the new repository will borrow objects from the same repository, and this option can be used to stop the borrowing."
            },
            {
                "flag": "-q",
                "long": "--quiet",
                "arg": null,
                "description": "Operate quietly. Progress is not reported to the standard error stream."
            },
            {
                "flag": "-v",
                "long": "--verbose",
                "arg": null,
                "description": "Run verbosely. Does not affect the reporting of progress status to the standard error stream."
            },
            {
                "flag": "",
                "long": "--progress",
                "arg": null,
                "description": "Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is specified. This flag forces progress status even if the standard error stream is not directed to a terminal. --server-option=<option> Transmit the given string to the server when communicating using protocol version 2. The given string must not contain a NUL or LF character. The server's handling of server options, including unknown ones, is server-specific. When multiple --server-option=<option> are given, they are all sent to the other side in the order listed on the command line."
            },
            {
                "flag": "-n",
                "long": "--no-checkout",
                "arg": null,
                "description": "No checkout of HEAD is performed after the clone is complete. --[no-]reject-shallow Fail if the source repository is a shallow repository. The clone.rejectShallow configuration variable can be used to specify the default."
            },
            {
                "flag": "",
                "long": "--bare",
                "arg": null,
                "description": "Make a bare Git repository. That is, instead of creating <directory> and placing the administrative files in <directory>/.git, make the <directory> itself the $GITDIR. This obviously implies the --no-checkout because there is nowhere to check out the working tree. Also the branch heads at the remote are copied directly to corresponding local branch heads, without mapping them to refs/remotes/origin/. When this option is used, neither remote-tracking branches nor the related configuration variables are created."
            },
            {
                "flag": "",
                "long": "--sparse",
                "arg": null,
                "description": "Initialize the sparse-checkout file so the working directory starts with only the files in the root of the repository. The sparse-checkout file can be modified to grow the working directory as needed. --filter=<filter-spec> Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. When using --filter, the supplied <filter-spec> is used for the partial clone filter. For example, --filter=blob:none will filter out all blobs (file contents) until needed by Git. Also, --filter=blob:limit=<size> will filter out all blobs of size at least <size>. For more details on filter specifications, see the --filter option in git-rev-list(1)."
            },
            {
                "flag": "",
                "long": "--mirror",
                "arg": null,
                "description": "Set up a mirror of the source repository. This implies --bare. Compared to --bare, --mirror not only maps local branches of the source to local branches of the target, it maps all refs (including remote-tracking branches, notes etc.) and sets up a refspec configuration such that all these refs are overwritten by a git remote update in the target repository."
            },
            {
                "flag": "-o",
                "long": "--origin",
                "arg": "<name>",
                "description": "Instead of using the remote name origin to keep track of the upstream repository, use <name>. Overrides clone.defaultRemoteName from the config."
            },
            {
                "flag": "-b",
                "long": "--branch",
                "arg": "<name>",
                "description": "Instead of pointing the newly created HEAD to the branch pointed to by the cloned repository's HEAD, point to <name> branch instead. In a non-bare repository, this is the branch that will be checked out. --branch can also take tags and detaches the HEAD at that commit in the resulting repository."
            },
            {
                "flag": "-u",
                "long": "--upload-pack",
                "arg": "<upload-pack>",
                "description": "When given, and the repository to clone from is accessed via ssh, this specifies a non-default path for the command run on the other end. --template=<templatedirectory> Specify the directory from which templates will be used; (See the \"TEMPLATE DIRECTORY\" section of git-init(1).) -c <key>=<value>, --config <key>=<value> Set a configuration variable in the newly-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out. The key is in the same format as expected by git-config(1) (e.g., core.eol=true). If multiple values are given for the same key, each value will be written to the config file. This makes it safe, for example, to add additional fetch refspecs to the origin remote. Due to limitations of the current implementation, some configuration variables do not take effect until after the initial fetch and checkout. Configuration variables known to not take effect are: remote.<name>.mirror and remote.<name>.tagOpt. Use the corresponding --mirror and --no-tags options instead."
            },
            {
                "flag": "",
                "long": "--depth",
                "arg": "<depth>",
                "description": "Create a shallow clone with a history truncated to the specified number of commits. Implies --single-branch unless --no-single-branch is given to fetch the histories near the tips of all branches. If you want to clone submodules shallowly, also pass --shallow-submodules. --shallow-since=<date> Create a shallow clone with a history after the specified time. --shallow-exclude=<revision> Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. This option can be specified multiple times. --[no-]single-branch Clone only the history leading to the tip of a single branch, either specified by the --branch option or the primary branch remote's HEAD points at. Further fetches into the resulting repository will only update the remote-tracking branch for the branch this option was used for the initial cloning. If the HEAD at the remote did not point at any branch when --single-branch clone was made, no remote-tracking branch is created."
            },
            {
                "flag": "",
                "long": "--no-tags",
                "arg": null,
                "description": "Don't clone any tags, and set remote.<remote>.tagOpt=--no-tags in the config, ensuring that future git pull and git fetch operations won't follow any tags. Subsequent explicit tag fetches will still work, (see git-fetch(1)). Can be used in conjunction with --single-branch to clone and maintain a branch with no references other than a single cloned branch. This is useful e.g. to maintain minimal clones of the default branch of some repository for search indexing. --recurse-submodules[=<pathspec>] After the clone is created, initialize and clone submodules within based on the provided pathspec. If no pathspec is provided, all submodules are initialized and cloned. This option can be given multiple times for pathspecs consisting of multiple entries. The resulting clone has submodule.active set to the provided pathspec, or \".\" (meaning all submodules) if no pathspec is provided. Submodules are initialized and cloned using their default settings. This is equivalent to running git submodule update --init --recursive <pathspec> immediately after the clone is finished. This option is ignored if the cloned repository does not have a worktree/checkout (i.e. if any of --no-checkout/-n, --bare, or --mirror is given) --[no-]shallow-submodules All submodules which are cloned will be shallow with a depth of 1. --[no-]remote-submodules All submodules which are cloned will use the status of the submodule's remote-tracking branch to update the submodule, rather than the superproject's recorded SHA-1. Equivalent to passing --remote to git submodule update. --separate-git-dir=<git dir> Instead of placing the cloned repository where it is supposed to be, place the cloned repository at the specified directory, then make a filesystem-agnostic Git symbolic link to there. The result is Git repository can be separated from working tree."
            },
            {
                "flag": "-j",
                "long": "--jobs",
                "arg": "<n>",
                "description": "The number of submodules fetched at the same time. Defaults to the submodule.fetchJobs option. <repository> The (possibly remote) repository to clone from. See the GIT URLS section below for more information on specifying repositories. <directory> The name of a new directory to clone into. The \"humanish\" part of the source repository is used if no directory is explicitly given (repo for /path/to/repo.git and foo for host.xz:foo/.git). Cloning into an existing directory is only allowed if the directory is empty."
            }
        ],
        "examples": [
            "o   Clone from upstream:",
            "$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux",
            "$ cd my-linux",
            "$ make",
            "o   Make a local clone that borrows from the current directory, without",
            "checking things out:",
            "$ git clone -l -s -n . ../copy",
            "$ cd ../copy",
            "$ git show-branch",
            "o   Clone from upstream while borrowing from an existing local",
            "directory:",
            "$ git clone --reference /git/linux.git \\",
            "git://git.kernel.org/pub/scm/.../linux.git \\",
            "my-linux",
            "$ cd my-linux",
            "o   Create a bare repository to publish your changes to the public:",
            "$ git clone --bare -l /home/proj/.git /pub/scm/proj.git"
        ],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 10,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 15,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-l, --local",
                        "lines": 17,
                        "flag": "-l",
                        "long": "--local"
                    },
                    {
                        "name": "--no-hardlinks",
                        "lines": 5,
                        "long": "--no-hardlinks"
                    },
                    {
                        "name": "-s, --shared",
                        "lines": 39,
                        "flag": "-s",
                        "long": "--shared"
                    },
                    {
                        "name": "--dissociate",
                        "lines": 8,
                        "long": "--dissociate"
                    },
                    {
                        "name": "-q, --quiet",
                        "lines": 3,
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "-v, --verbose",
                        "lines": 3,
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "--progress",
                        "lines": 13,
                        "long": "--progress"
                    },
                    {
                        "name": "-n, --no-checkout",
                        "lines": 7,
                        "flag": "-n",
                        "long": "--no-checkout"
                    },
                    {
                        "name": "--bare",
                        "lines": 10,
                        "long": "--bare"
                    },
                    {
                        "name": "--sparse",
                        "lines": 15,
                        "long": "--sparse"
                    },
                    {
                        "name": "--mirror",
                        "lines": 7,
                        "long": "--mirror"
                    },
                    {
                        "name": "-o <name>, --origin <name>",
                        "lines": 4,
                        "flag": "-o",
                        "long": "--origin",
                        "arg": "<name>"
                    },
                    {
                        "name": "-b <name>, --branch <name>",
                        "lines": 6,
                        "flag": "-b",
                        "long": "--branch",
                        "arg": "<name>"
                    },
                    {
                        "name": "-u <upload-pack>, --upload-pack <upload-pack>",
                        "lines": 23,
                        "flag": "-u",
                        "long": "--upload-pack",
                        "arg": "<upload-pack>"
                    },
                    {
                        "name": "--depth <depth>",
                        "lines": 23,
                        "long": "--depth",
                        "arg": "<depth>"
                    },
                    {
                        "name": "--no-tags",
                        "lines": 40,
                        "long": "--no-tags"
                    },
                    {
                        "name": "-j <n>, --jobs <n>",
                        "lines": 14,
                        "flag": "-j",
                        "long": "--jobs",
                        "arg": "<n>"
                    }
                ]
            },
            {
                "name": "GIT URLS",
                "lines": 94,
                "subsections": []
            },
            {
                "name": "EXAMPLES",
                "lines": 25,
                "subsections": []
            },
            {
                "name": "GIT",
                "lines": 3,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "git-clone - Clone a repository into a new directory\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "git clone [--template=<templatedirectory>]\n[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]\n[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]\n[--dissociate] [--separate-git-dir <git dir>]\n[--depth <depth>] [--[no-]single-branch] [--no-tags]\n[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]\n[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]\n[--filter=<filter>] [--] <repository>\n[<directory>]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Clones a repository into a newly created directory, creates\nremote-tracking branches for each branch in the cloned repository\n(visible using git branch --remotes), and creates and checks out an\ninitial branch that is forked from the cloned repository's currently\nactive branch.\n\nAfter the clone, a plain git fetch without arguments will update all\nthe remote-tracking branches, and a git pull without arguments will in\naddition merge the remote master branch into the current master branch,\nif any (this is untrue when \"--single-branch\" is given; see below).\n\nThis default configuration is achieved by creating references to the\nremote branch heads under refs/remotes/origin and by initializing\nremote.origin.url and remote.origin.fetch configuration variables.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-l, --local",
                        "content": "When the repository to clone from is on a local machine, this flag\nbypasses the normal \"Git aware\" transport mechanism and clones the\nrepository by making a copy of HEAD and everything under objects\nand refs directories. The files under .git/objects/ directory are\nhardlinked to save space when possible.\n\nIf the repository is specified as a local path (e.g.,\n/path/to/repo), this is the default, and --local is essentially a\nno-op. If the repository is specified as a URL, then this flag is\nignored (and we never use the local optimizations). Specifying\n--no-local will override the default when /path/to/repo is given,\nusing the regular Git transport instead.\n\nNOTE: this operation can race with concurrent modification to the\nsource repository, similar to running cp -r src dst while modifying\nsrc.\n",
                        "flag": "-l",
                        "long": "--local"
                    },
                    {
                        "name": "--no-hardlinks",
                        "content": "Force the cloning process from a repository on a local filesystem\nto copy the files under the .git/objects directory instead of using\nhardlinks. This may be desirable if you are trying to make a\nback-up of your repository.\n",
                        "long": "--no-hardlinks"
                    },
                    {
                        "name": "-s, --shared",
                        "content": "When the repository to clone is on the local machine, instead of\nusing hard links, automatically setup .git/objects/info/alternates\nto share the objects with the source repository. The resulting\nrepository starts out without any object of its own.\n\nNOTE: this is a possibly dangerous operation; do not use it unless\nyou understand what it does. If you clone your repository using\nthis option and then delete branches (or use any other Git command\nthat makes any existing commit unreferenced) in the source\nrepository, some objects may become unreferenced (or dangling).\nThese objects may be removed by normal Git operations (such as git\ncommit) which automatically call git maintenance run --auto. (See\ngit-maintenance(1).) If these objects are removed and were\nreferenced by the cloned repository, then the cloned repository\nwill become corrupt.\n\nNote that running git repack without the --local option in a\nrepository cloned with --shared will copy objects from the source\nrepository into a pack in the cloned repository, removing the disk\nspace savings of clone --shared. It is safe, however, to run git\ngc, which uses the --local option by default.\n\nIf you want to break the dependency of a repository cloned with\n--shared on its source repository, you can simply run git repack -a\nto copy all objects from the source repository into a pack in the\ncloned repository.\n\n--reference[-if-able] <repository>\nIf the reference repository is on the local machine, automatically\nsetup .git/objects/info/alternates to obtain objects from the\nreference repository. Using an already existing repository as an\nalternate will require fewer objects to be copied from the\nrepository being cloned, reducing network and local storage costs.\nWhen using the --reference-if-able, a non existing directory is\nskipped with a warning instead of aborting the clone.\n\nNOTE: see the NOTE for the --shared option, and also the\n--dissociate option.\n",
                        "flag": "-s",
                        "long": "--shared"
                    },
                    {
                        "name": "--dissociate",
                        "content": "Borrow the objects from reference repositories specified with the\n--reference options only to reduce network transfer, and stop\nborrowing from them after a clone is made by making necessary local\ncopies of borrowed objects. This option can also be used when\ncloning locally from a repository that already borrows objects from\nanother repository--the new repository will borrow objects from the\nsame repository, and this option can be used to stop the borrowing.\n",
                        "long": "--dissociate"
                    },
                    {
                        "name": "-q, --quiet",
                        "content": "Operate quietly. Progress is not reported to the standard error\nstream.\n",
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "-v, --verbose",
                        "content": "Run verbosely. Does not affect the reporting of progress status to\nthe standard error stream.\n",
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "--progress",
                        "content": "Progress status is reported on the standard error stream by default\nwhen it is attached to a terminal, unless --quiet is specified.\nThis flag forces progress status even if the standard error stream\nis not directed to a terminal.\n\n--server-option=<option>\nTransmit the given string to the server when communicating using\nprotocol version 2. The given string must not contain a NUL or LF\ncharacter. The server's handling of server options, including\nunknown ones, is server-specific. When multiple\n--server-option=<option> are given, they are all sent to the other\nside in the order listed on the command line.\n",
                        "long": "--progress"
                    },
                    {
                        "name": "-n, --no-checkout",
                        "content": "No checkout of HEAD is performed after the clone is complete.\n\n--[no-]reject-shallow\nFail if the source repository is a shallow repository. The\nclone.rejectShallow configuration variable can be used to specify\nthe default.\n",
                        "flag": "-n",
                        "long": "--no-checkout"
                    },
                    {
                        "name": "--bare",
                        "content": "Make a bare Git repository. That is, instead of creating\n<directory> and placing the administrative files in\n<directory>/.git, make the <directory> itself the $GITDIR. This\nobviously implies the --no-checkout because there is nowhere to\ncheck out the working tree. Also the branch heads at the remote are\ncopied directly to corresponding local branch heads, without\nmapping them to refs/remotes/origin/. When this option is used,\nneither remote-tracking branches nor the related configuration\nvariables are created.\n",
                        "long": "--bare"
                    },
                    {
                        "name": "--sparse",
                        "content": "Initialize the sparse-checkout file so the working directory starts\nwith only the files in the root of the repository. The\nsparse-checkout file can be modified to grow the working directory\nas needed.\n\n--filter=<filter-spec>\nUse the partial clone feature and request that the server sends a\nsubset of reachable objects according to a given object filter.\nWhen using --filter, the supplied <filter-spec> is used for the\npartial clone filter. For example, --filter=blob:none will filter\nout all blobs (file contents) until needed by Git. Also,\n--filter=blob:limit=<size> will filter out all blobs of size at\nleast <size>. For more details on filter specifications, see the\n--filter option in git-rev-list(1).\n",
                        "long": "--sparse"
                    },
                    {
                        "name": "--mirror",
                        "content": "Set up a mirror of the source repository. This implies --bare.\nCompared to --bare, --mirror not only maps local branches of the\nsource to local branches of the target, it maps all refs (including\nremote-tracking branches, notes etc.) and sets up a refspec\nconfiguration such that all these refs are overwritten by a git\nremote update in the target repository.\n",
                        "long": "--mirror"
                    },
                    {
                        "name": "-o <name>, --origin <name>",
                        "content": "Instead of using the remote name origin to keep track of the\nupstream repository, use <name>. Overrides clone.defaultRemoteName\nfrom the config.\n",
                        "flag": "-o",
                        "long": "--origin",
                        "arg": "<name>"
                    },
                    {
                        "name": "-b <name>, --branch <name>",
                        "content": "Instead of pointing the newly created HEAD to the branch pointed to\nby the cloned repository's HEAD, point to <name> branch instead. In\na non-bare repository, this is the branch that will be checked out.\n--branch can also take tags and detaches the HEAD at that commit in\nthe resulting repository.\n",
                        "flag": "-b",
                        "long": "--branch",
                        "arg": "<name>"
                    },
                    {
                        "name": "-u <upload-pack>, --upload-pack <upload-pack>",
                        "content": "When given, and the repository to clone from is accessed via ssh,\nthis specifies a non-default path for the command run on the other\nend.\n\n--template=<templatedirectory>\nSpecify the directory from which templates will be used; (See the\n\"TEMPLATE DIRECTORY\" section of git-init(1).)\n\n-c <key>=<value>, --config <key>=<value>\nSet a configuration variable in the newly-created repository; this\ntakes effect immediately after the repository is initialized, but\nbefore the remote history is fetched or any files checked out. The\nkey is in the same format as expected by git-config(1) (e.g.,\ncore.eol=true). If multiple values are given for the same key, each\nvalue will be written to the config file. This makes it safe, for\nexample, to add additional fetch refspecs to the origin remote.\n\nDue to limitations of the current implementation, some\nconfiguration variables do not take effect until after the initial\nfetch and checkout. Configuration variables known to not take\neffect are: remote.<name>.mirror and remote.<name>.tagOpt. Use the\ncorresponding --mirror and --no-tags options instead.\n",
                        "flag": "-u",
                        "long": "--upload-pack",
                        "arg": "<upload-pack>"
                    },
                    {
                        "name": "--depth <depth>",
                        "content": "Create a shallow clone with a history truncated to the specified\nnumber of commits. Implies --single-branch unless\n--no-single-branch is given to fetch the histories near the tips of\nall branches. If you want to clone submodules shallowly, also pass\n--shallow-submodules.\n\n--shallow-since=<date>\nCreate a shallow clone with a history after the specified time.\n\n--shallow-exclude=<revision>\nCreate a shallow clone with a history, excluding commits reachable\nfrom a specified remote branch or tag. This option can be specified\nmultiple times.\n\n--[no-]single-branch\nClone only the history leading to the tip of a single branch,\neither specified by the --branch option or the primary branch\nremote's HEAD points at. Further fetches into the resulting\nrepository will only update the remote-tracking branch for the\nbranch this option was used for the initial cloning. If the HEAD at\nthe remote did not point at any branch when --single-branch clone\nwas made, no remote-tracking branch is created.\n",
                        "long": "--depth",
                        "arg": "<depth>"
                    },
                    {
                        "name": "--no-tags",
                        "content": "Don't clone any tags, and set remote.<remote>.tagOpt=--no-tags in\nthe config, ensuring that future git pull and git fetch operations\nwon't follow any tags. Subsequent explicit tag fetches will still\nwork, (see git-fetch(1)).\n\nCan be used in conjunction with --single-branch to clone and\nmaintain a branch with no references other than a single cloned\nbranch. This is useful e.g. to maintain minimal clones of the\ndefault branch of some repository for search indexing.\n\n--recurse-submodules[=<pathspec>]\nAfter the clone is created, initialize and clone submodules within\nbased on the provided pathspec. If no pathspec is provided, all\nsubmodules are initialized and cloned. This option can be given\nmultiple times for pathspecs consisting of multiple entries. The\nresulting clone has submodule.active set to the provided pathspec,\nor \".\" (meaning all submodules) if no pathspec is provided.\n\nSubmodules are initialized and cloned using their default settings.\nThis is equivalent to running git submodule update --init\n--recursive <pathspec> immediately after the clone is finished.\nThis option is ignored if the cloned repository does not have a\nworktree/checkout (i.e. if any of --no-checkout/-n, --bare, or\n--mirror is given)\n\n--[no-]shallow-submodules\nAll submodules which are cloned will be shallow with a depth of 1.\n\n--[no-]remote-submodules\nAll submodules which are cloned will use the status of the\nsubmodule's remote-tracking branch to update the submodule, rather\nthan the superproject's recorded SHA-1. Equivalent to passing\n--remote to git submodule update.\n\n--separate-git-dir=<git dir>\nInstead of placing the cloned repository where it is supposed to\nbe, place the cloned repository at the specified directory, then\nmake a filesystem-agnostic Git symbolic link to there. The result\nis Git repository can be separated from working tree.\n",
                        "long": "--no-tags"
                    },
                    {
                        "name": "-j <n>, --jobs <n>",
                        "content": "The number of submodules fetched at the same time. Defaults to the\nsubmodule.fetchJobs option.\n\n<repository>\nThe (possibly remote) repository to clone from. See the GIT URLS\nsection below for more information on specifying repositories.\n\n<directory>\nThe name of a new directory to clone into. The \"humanish\" part of\nthe source repository is used if no directory is explicitly given\n(repo for /path/to/repo.git and foo for host.xz:foo/.git). Cloning\ninto an existing directory is only allowed if the directory is\nempty.\n",
                        "flag": "-j",
                        "long": "--jobs",
                        "arg": "<n>"
                    }
                ]
            },
            "GIT URLS": {
                "content": "In general, URLs contain information about the transport protocol, the\naddress of the remote server, and the path to the repository. Depending\non the transport protocol, some of this information may be absent.\n\nGit supports ssh, git, http, and https protocols (in addition, ftp, and\nftps can be used for fetching, but this is inefficient and deprecated;\ndo not use it).\n\nThe native transport (i.e. git:// URL) does no authentication and\nshould be used with caution on unsecured networks.\n\nThe following syntaxes may be used with them:\n\no   ssh://[user@]host.xz[:port]/path/to/repo.git/\n\no   git://host.xz[:port]/path/to/repo.git/\n\no   http[s]://host.xz[:port]/path/to/repo.git/\n\no   ftp[s]://host.xz[:port]/path/to/repo.git/\n\nAn alternative scp-like syntax may also be used with the ssh protocol:\n\no   [user@]host.xz:path/to/repo.git/\n\nThis syntax is only recognized if there are no slashes before the first\ncolon. This helps differentiate a local path that contains a colon. For\nexample the local path foo:bar could be specified as an absolute path\nor ./foo:bar to avoid being misinterpreted as an ssh url.\n\nThe ssh and git protocols additionally support ~username expansion:\n\no   ssh://[user@]host.xz[:port]/~[user]/path/to/repo.git/\n\no   git://host.xz[:port]/~[user]/path/to/repo.git/\n\no   [user@]host.xz:/~[user]/path/to/repo.git/\n\nFor local repositories, also supported by Git natively, the following\nsyntaxes may be used:\n\no   /path/to/repo.git/\n\no   file:///path/to/repo.git/\n\nThese two syntaxes are mostly equivalent, except the former implies\n--local option.\n\ngit clone, git fetch and git pull, but not git push, will also accept a\nsuitable bundle file. See git-bundle(1).\n\nWhen Git doesn't know how to handle a certain transport protocol, it\nattempts to use the remote-<transport> remote helper, if one exists. To\nexplicitly request a remote helper, the following syntax may be used:\n\no   <transport>::<address>\n\nwhere <address> may be a path, a server and path, or an arbitrary\nURL-like string recognized by the specific remote helper being invoked.\nSee gitremote-helpers(7) for details.\n\nIf there are a large number of similarly-named remote repositories and\nyou want to use a different format for them (such that the URLs you use\nwill be rewritten into URLs that work), you can create a configuration\nsection of the form:\n\n[url \"<actual url base>\"]\ninsteadOf = <other url base>\n\nFor example, with this:\n\n[url \"git://git.host.xz/\"]\ninsteadOf = host.xz:/path/to/\ninsteadOf = work:\n\na URL like \"work:repo.git\" or like \"host.xz:/path/to/repo.git\" will be\nrewritten in any context that takes a URL to be\n\"git://git.host.xz/repo.git\".\n\nIf you want to rewrite URLs for push only, you can create a\nconfiguration section of the form:\n\n[url \"<actual url base>\"]\npushInsteadOf = <other url base>\n\nFor example, with this:\n\n[url \"ssh://example.org/\"]\npushInsteadOf = git://example.org/\n\na URL like \"git://example.org/path/to/repo.git\" will be rewritten to\n\"ssh://example.org/path/to/repo.git\" for pushes, but pulls will still\nuse the original URL.\n",
                "subsections": []
            },
            "EXAMPLES": {
                "content": "o   Clone from upstream:\n\n$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux\n$ cd my-linux\n$ make\n\no   Make a local clone that borrows from the current directory, without\nchecking things out:\n\n$ git clone -l -s -n . ../copy\n$ cd ../copy\n$ git show-branch\n\no   Clone from upstream while borrowing from an existing local\ndirectory:\n\n$ git clone --reference /git/linux.git \\\ngit://git.kernel.org/pub/scm/.../linux.git \\\nmy-linux\n$ cd my-linux\n\no   Create a bare repository to publish your changes to the public:\n\n$ git clone --bare -l /home/proj/.git /pub/scm/proj.git\n",
                "subsections": []
            },
            "GIT": {
                "content": "Part of the git(1) suite\n\nGit 2.34.1                        02/26/2026                      GIT-CLONE(1)",
                "subsections": []
            }
        }
    }
}