gh-repo-clone - Man Page

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.

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

See Also

gh-repo(1)

Referenced By

gh-repo(1).

Feb 2024 GitHub CLI manual