github.com/1800alex/go-git-cmd-wrapper/v2@v2.2.5/clone/doc.go (about)

     1  /*
     2  Package clone git-clone - Clone a repository into a new directory.
     3  
     4  SYNOPSIS
     5  
     6  Reference: https://git-scm.com/docs/git-clone
     7  
     8  		git clone [--template=<template_directory>]
     9  						 [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
    10  						 [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
    11  						 [--dissociate] [--separate-git-dir <git dir>]
    12  						 [--depth <depth>] [--[no-]single-branch]
    13  						 [--recurse-submodules] [--[no-]shallow-submodules]
    14  						 [--jobs <n>] [--] <repository> [<directory>]
    15  
    16  DESCRIPTION
    17  
    18  Clones a repository into a newly created directory, creates remote-tracking branches for each branch in the cloned repository (visible using git branch -r), and creates and checks out an initial branch that is forked from the cloned repository’s currently active branch.
    19  
    20  After the clone, a plain git fetch without arguments will update all the remote-tracking branches, and a git pull without arguments will in addition merge the remote master branch into the current master branch, if any (this is untrue when "--single-branch" is given; see below).
    21  
    22  This default configuration is achieved by creating references to the remote branch heads under refs/remotes/origin and by initializing remote.origin.url and remote.origin.fetch configuration variables.
    23  
    24  */
    25  package clone