gt-release-edit(1)

gt-release-edit1

Edit releases

Usage

gt release edit <tag> ... [flags]

Overview

Edit the title, notes, tag, target, draft or prerelease state of releases. Without flags on a terminal, a form starts from the current values of each release and only what it changes is sent. In a clone, a target that is no branch on the server, such as HEAD or a short SHA, names the commit it resolves to in the clone.

Json fields

assets, author, body, created_at, draft, id, prerelease, published_at, tag,
target, title, url

Options

-d, --draft[=false]
Save the release as a draft

-e, --editor[=false]
Write release notes in an editor

-h, --help[=false]
help for edit

-n, --notes=""
Release notes

-F, --notes-file=""
Read release notes from a file, or - for standard input

-p, --prerelease[=false]
Mark the release as a prerelease

--tag=""
Change the release's tag (one release only)

--target=""
Branch or commit the tag points to, when it is new

-t, --title=""
Release title

Options inherited from parent commands

--csv[=""]
Output CSV with the specified comma-separated fields, or all fields

--cwd=""
Working directory for repository discovery

--debug[=false]
Log the method, URL, status, and duration of each HTTP request to stderr

--host=""
Gitea instance URL, including any base path

--interactive[=false]
Allow prompts with machine output

-q, --jq=""
Filter JSON output using a jq expression; implies --json

--json[=""]
Output JSON with the specified comma-separated fields, or all fields

--no-input[=false]
Disable prompts and implicit editor/browser interactions

--remote=""
Git remote used for repository discovery

-R, --repo=""
Select a repository as OWNER/REPO or URL

--sudo=""
Perform API requests as this user (requires an administrator account)

--user=""
Account name on the selected instance

Examples

# Edit a release in a form
$ gt release edit v1.0.0
$ gt release edit v1.0.0 --title "1.0.0" --notes-file CHANGELOG.md
$ gt release edit v1.0.0-rc1 v1.0.0-rc2 --prerelease=false

From gitea-cli 1.0.0-1 in Arch Linux 2026-11-07. Parsed by carta from the page's man source.