GH-PR-EDIT(1)

πŸ’… gh-pr-edit β€” edit a pull request (yes, THE gh pr edit, from the GitHub CLI manual)


✨ NAME ✨

gh-pr-edit β€” bestie, this is the one that edits a pull request. Glow-ups only. πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

gh pr edit [<number> | <url> | <branch>] [flags]

πŸ’– DESCRIPTION πŸ’–

Okay so. You're editing a pull request. That's the whole vibe. ✨

No argument? No problem β€” the command just grabs the pull request that belongs to the current branch. Main character default behavior, honestly. πŸ‘‘

Editing a pull request's projects needs authorization with the project scope. Lowkey important, so to authorize, run:

gh auth refresh -s project

Use --attach to upload an image or video. Here's the tea 🍡: without a body flag, the pull request keeps the body it already has β€” and the attachment just gets appended to it. If the body already references an attached file (like ![alt](./login.png)), that reference is rewritten to point at the uploaded asset instead. And you can attach up to 50 files per command. Not 51. 50. Slay.

Alt text for an image follows the path after #, as in --attach './login.png#The login error state'. Without it, the filename is used. If a reference already exists in the body, it keeps the alt text written there. Video renders as a player and has no alt text, so it literally cannot be given any. πŸ’€

And if some attachments upload and others fail? The pull request is still updated with the ones that succeeded. The command then exits with a non-zero status, but the pull request's URL is still printed to stdout. So you still get the link, bestie. 🫢

The --add-assignee and --remove-assignee flags both support these special values:

  • @me: assign or unassign yourself
  • @copilot: assign or unassign Copilot (not supported on GitHub Enterprise Server)

The --add-reviewer and --remove-reviewer flags support this special value:

  • @copilot: request or remove review from Copilot (not supported on GitHub Enterprise Server)

🌸 OPTIONS 🌸

  • --add-assignee <login> β€” add assigned users by their login. Use "@me" to assign yourself, or "@copilot" to assign Copilot. 🫢
  • --add-label <name> β€” add labels by name. 🏷️
  • --add-project <title> β€” add the pull request to projects by title.
  • --add-reviewer <login> β€” add or re-request reviewers by their login. Use "@copilot" to request review from Copilot. πŸ‘€
  • --attach <file> β€” attach an image or video file, in '#' format. πŸ“Ž
  • -B, --base <branch> β€” change the base branch for this pull request. 🌿
  • -b, --body <string> β€” set the new body.
  • -F, --body-file <file> β€” read body text from file (use "-" to read from standard input).
  • -m, --milestone <name> β€” edit the milestone the pull request belongs to, by name. 🎯
  • --remove-assignee <login> β€” remove assigned users by their login. Use "@me" to unassign yourself, or "@copilot" to unassign Copilot.
  • --remove-label <name> β€” remove labels by name.
  • --remove-milestone β€” remove the milestone association from the pull request.
  • --remove-project <title> β€” remove the pull request from projects by title.
  • --remove-reviewer <login> β€” remove reviewers by their login. Use "@copilot" to remove review request from Copilot.
  • -t, --title <string> β€” set the new title. ✍️

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

  • -R, --repo <[HOST/]OWNER/REPO> β€” select another repository using the [HOST/]OWNER/REPO format. πŸŒ€

πŸ”₯ EXIT CODES πŸ”₯

  • 0: Successful execution βœ…
  • 1: Error 😭
  • 2: Command canceled πŸ™ˆ
  • 4: Authentication required πŸ”
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. iykyk πŸ’…

🌈 EXAMPLE 🌈

# Edit the title and body of a pull request
$ gh pr edit 23 --title "I found a bug" --body "Nothing works"

# Use a file as the body
$ gh pr edit 23 --body-file body.txt

# Append a screenshot to the body, with alt text after "#"
$ gh pr edit 23 --attach './login.png#The login error state'

# Append multiple files by repeating the flag
$ gh pr edit 23 --attach ./before.png --attach ./after.png

# Manage labels
$ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core"

# Manage reviewers
$ gh pr edit 23 --add-reviewer monalisa,hubot --remove-reviewer myorg/team-name

# Re-request review
$ gh pr edit 23 --add-reviewer monalisa

# Request a review from GitHub Copilot
$ gh pr edit 23 --add-reviewer "@copilot"

# Manage assignees
$ gh pr edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot

# Assign GitHub Copilot
$ gh pr edit 23 --add-assignee "@copilot"

# Manage projects and milestones
$ gh pr edit 23 --add-project "Roadmap" --remove-project v1,v2
$ gh pr edit 23 --milestone "Version 1"
$ gh pr edit 23 --remove-milestone

πŸŽ€ SEE ALSO πŸŽ€

  • gh-pr(1) β€” go read it, bestie 🫢

That's the whole page! This lil icon was brought to you by GitHub CLI v2.102.0, dated Oct 2026 β€” periodt. βœ¨πŸ’œπŸ¦‹

πŸ“¦ where this page comes from