spotube/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-edit.1

111 lines
2.5 KiB
Groff

.nh
.TH "GH-ISSUE-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual"
.SH NAME
gh-issue-edit - Edit issues
.SH SYNOPSIS
\fBgh issue edit {<numbers> | <urls>} [flags]\fR
.SH DESCRIPTION
Edit one or more issues within the same repository.
.PP
Editing issues' projects requires authorization with the \fBproject\fR scope.
To authorize, run \fBgh auth refresh -s project\fR\&.
.PP
The \fB--add-assignee\fR and \fB--remove-assignee\fR flags both support
the following special values:
- \fB@me\fR: assign or unassign yourself
- \fB@copilot\fR: assign or unassign Copilot (not supported on GitHub Enterprise Server)
.SH OPTIONS
.TP
\fB--add-assignee\fR \fB<login>\fR
Add assigned users by their login. Use "@me" to assign yourself, or "@copilot" to assign Copilot.
.TP
\fB--add-label\fR \fB<name>\fR
Add labels by name
.TP
\fB--add-project\fR \fB<title>\fR
Add the issue to projects by title
.TP
\fB-b\fR, \fB--body\fR \fB<string>\fR
Set the new body.
.TP
\fB-F\fR, \fB--body-file\fR \fB<file>\fR
Read body text from file (use "-" to read from standard input)
.TP
\fB-m\fR, \fB--milestone\fR \fB<name>\fR
Edit the milestone the issue belongs to by name
.TP
\fB--remove-assignee\fR \fB<login>\fR
Remove assigned users by their login. Use "@me" to unassign yourself, or "@copilot" to unassign Copilot.
.TP
\fB--remove-label\fR \fB<name>\fR
Remove labels by name
.TP
\fB--remove-milestone\fR
Remove the milestone association from the issue
.TP
\fB--remove-project\fR \fB<title>\fR
Remove the issue from projects by title
.TP
\fB-t\fR, \fB--title\fR \fB<string>\fR
Set the new title.
.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
$ gh issue edit 23 --title "I found a bug" --body "Nothing works"
$ gh issue edit 23 --add-label "bug,help wanted" --remove-label "core"
$ gh issue edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot
$ gh issue edit 23 --add-assignee "@copilot"
$ gh issue edit 23 --add-project "Roadmap" --remove-project v1,v2
$ gh issue edit 23 --milestone "Version 1"
$ gh issue edit 23 --remove-milestone
$ gh issue edit 23 --body-file body.txt
$ gh issue edit 23 34 --add-label "help wanted"
.EE
.SH SEE ALSO
\fBgh-issue(1)\fR