GH-REPO-CLONE(1)               GitHub CLI manual              GH-REPO-CLONE(1)



NAME
       gh-repo-clone - Clone a repository locally



SYNOPSIS
       gh repo clone <repository> [<directory>] [-- <gitflags>...]



DESCRIPTION
       Clone a GitHub repository locally. Pass additional git clone flags by
       listing them after --.


       If the OWNER/ portion of the OWNER/REPO repository argument is omitted,
       it defaults to the name of the authenticating user.


       When a protocol scheme is not provided in the repository argument, the
       git_protocol will be chosen from your configuration, which can be
       checked via gh config get git_protocol. If the protocol scheme is
       provided, the repository will be cloned using the specified protocol.


       If the repository is a fork, its parent repository will be added as an
       additional git remote called upstream. The remote name can be
       configured using --upstream-remote-name.  The --upstream-remote-name
       option supports an @owner value which will name the remote after the
       owner of the parent repository.


       If the repository is a fork, its parent repository will be set as the
       default remote repository.



OPTIONS
       -u, --upstream-remote-name <string> (default "upstream")
              Upstream remote name when cloning a fork



EXAMPLE
       # Clone a repository from a specific org
       $ gh repo clone cli/cli

       # Clone a repository from your own account
       $ gh repo clone myrepo

       # Clone a repo, overriding git protocol configuration
       $ gh repo clone https://github.com/cli/cli
       $ gh repo clone git@github.com:cli/cli.git

       # Clone a repository to a custom directory
       $ gh repo clone cli/cli workspace/cli

       # Clone a repository with additional git clone flags
       $ gh repo clone cli/cli -- --depth=1




SEE ALSO
       gh-repo(1)

                                   May 2024                   GH-REPO-CLONE(1)