.nh
.TH "GH-RUN-DOWNLOAD" "1" "Oct 2024" "GitHub CLI 2.58.0" "GitHub CLI manual"

.SH NAME
gh-run-download - Download artifacts generated by a workflow run


.SH SYNOPSIS
\fBgh run download [<run-id>] [flags]\fR


.SH DESCRIPTION
Download artifacts generated by a GitHub Actions workflow run.

.PP
The contents of each artifact will be extracted under separate directories based on
the artifact name. If only a single artifact is specified, it will be extracted into
the current directory.

.PP
By default, this command downloads the latest artifact created and uploaded through
GitHub Actions. Because workflows can delete or overwrite artifacts, \fB<run-id>\fR
must be used to select an artifact from a specific workflow run.


.SH OPTIONS
.TP
\fB-D\fR, \fB--dir\fR \fB<string> (default ".")\fR
The directory to download artifacts into

.TP
\fB-n\fR, \fB--name\fR \fB<stringArray>\fR
Download artifacts that match any of the given names

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


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


.SH EXIT CODES
0: Successful execution

.PP
1: Error

.PP
2: Command canceled

.PP
4: Authentication required

.PP
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.


.SH EXAMPLE
.EX
# Download all artifacts generated by a workflow run
$ gh run download <run-id>

# Download a specific artifact within a run
$ gh run download <run-id> -n <name>

# Download specific artifacts across all runs in a repository
$ gh run download -n <name1> -n <name2>

# Select artifacts to download interactively
$ gh run download

.EE


.SH SEE ALSO
\fBgh-run(1)\fR