.nh
.TH "GH-RELEASE-DOWNLOAD" "1" "Oct 2022" "" "GitHub CLI manual"

.SH NAME
.PP
gh-release-download - Download release assets


.SH SYNOPSIS
.PP
\fB\fCgh release download [<tag>] [flags]\fR


.SH DESCRIPTION
.PP
Download assets from a GitHub release.

.PP
Without an explicit tag name argument, assets are downloaded from the
latest release in the project. In this case, '--pattern' is required.


.SH OPTIONS
.TP
\fB\fC-A\fR, \fB\fC--archive\fR \fB\fC<format>\fR
Download the source code archive in the specified format (zip or tar.gz)

.TP
\fB\fC--clobber\fR
Overwrite existing files of the same name

.TP
\fB\fC-D\fR, \fB\fC--dir\fR \fB\fC<string>\fR
The directory to download files into

.TP
\fB\fC-p\fR, \fB\fC--pattern\fR \fB\fC<stringArray>\fR
Download only assets that match a glob pattern

.TP
\fB\fC--skip-existing\fR
Skip downloading when files of the same name exist


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.TP
\fB\fC-R\fR, \fB\fC--repo\fR \fB\fC<[HOST/]OWNER/REPO>\fR
Select another repository using the [HOST/]OWNER/REPO format


.SH EXAMPLE
.PP
.RS

.nf
# download all assets from a specific release
$ gh release download v1.2.3

# download only Debian packages for the latest release
$ gh release download --pattern '*.deb'

# specify multiple file patterns
$ gh release download -p '*.deb' -p '*.rpm'

# download the archive of the source code for a release
$ gh release download v1.2.3 --archive=zip


.fi
.RE


.SH SEE ALSO
.PP
\fB\fCgh-release(1)\fR