gh-issue-artifact-edit(1)

NAME

gh-issue-artifact-edit - Edit an issue artifact (preview)

SYNOPSIS

gh issue artifact edit {<issue> <artifact-number> | <artifact-url>} [flags]

DESCRIPTION

Rename an issue artifact or replace its content. The type never changes, so a link's new content must be an http(s) URL or a .url Internet Shortcut file.

Name the artifact by its issue and number, or by its URL. <issue> is an issue number or URL.

With only --attach, the attachments are appended to the current content.

With --restore-version, an earlier version's name and content are saved as a new version. gh issue artifact view shows the edit history.

OPTIONS

--attach <file>

Attach an image or video file, in '#' format

-b, --body <string>

New content; for a link, a URL

-F, --body-file <file>

Read new content from file (use "-" to read from standard input)

--name <string>

New name

--restore-version <number> (default 0)

Restore the version with this number from the edit history

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.

EXAMPLE

# Rename an artifact
$ gh issue artifact edit 142 2 --name 'OAuth callback plan v2'
# Replace a document's content with a file
$ gh issue artifact edit 142 2 --body-file 2-OAuth-callback-plan.md
# Point a link at a new URL
$ gh issue artifact edit 142 3 --body https://github.com/monalisa/monas-cafe/wiki/OAuth-runbook-v2
# Append an image to a document
$ gh issue artifact edit 142 2 --attach ./signin-flow.png
# Restore an earlier version
$ gh issue artifact edit 142 2 --restore-version 5

SEE ALSO

gh-issue-artifact(1)