GH-ISSUE-ARTIFACT-CREATE(1)

πŸ“¦ version 2.103.3, in nixos 26.05, nixpkgs unstable

πŸŽ€ GH-ISSUE-ARTIFACT-CREATE(1) πŸŽ€

okay so this is from the GitHub CLI manual bestie, and it's literally about making issue artifacts. preview mode, very exclusive πŸ’…


✨ NAME ✨

gh-issue-artifact-create β€” create issue artifacts (preview)


πŸ¦‹ SYNOPSIS πŸ¦‹

gh issue artifact create {<issue-number> | <issue-url>} [<file>[#<name>]
| <url>]... [flags]

πŸ’– DESCRIPTION πŸ’–

So every file or URL you hand over gets its own artifact, one each β€” no cap. Here's the vibe check on what becomes what:

  • A text file becomes a document named after the file. Want a different name? Just add #<name> to it. slay.
  • A .html or .htm file becomes an HTML document.
  • A URL β€” or a .url Internet Shortcut file β€” becomes a link, and a URL is named after its host. iconic behavior honestly.

Now, artifact names can't contain some characters, parentheses being a big one. When a file's name has them, they get removed, so plan (1).md ends up named plan 1.md. it's giving tidy ✨

Use --body if you want to create a single document from text, or --body-file to create one artifact from a file β€” and - reads standard input, obviously 🫢. Then --name sets its name.

Documents get saved as generic, and HTML documents as embedded_html. If you want to force it, use --type to set the type of every document instead, whatever the file extension says. And a plan currently behaves the same as a generic document β€” that's just how it is rn πŸ™ˆ


πŸ’… OPTIONS πŸ’…

  • --attach <file> β€” attach an image or video file, in '#' format
  • -b, --body <string> β€” content for a single document
  • -F, --body-file <file> β€” read content for a single artifact from file (use - to read from standard input)
  • --name <string> β€” name for a single artifact
  • --type <string> β€” type for documents: {generic|plan|embedded_html}

🌸 OPTIONS INHERITED FROM PARENT COMMANDS 🌸

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

🌈 ALIASES 🌈

gh issue artifact new β€” same energy, shorter walk πŸšΆβ€β™€οΈ


⭐ 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 πŸ“

Create a document from a file:

$ gh issue artifact create 142 signin-plan.md

Create documents from two files, naming the first:

$ gh issue artifact create 142 'docs/signin-plan.md#Sign-in plan' oauth-research.md

Create an HTML document from a file:

$ gh issue artifact create 142 menu-prototype.html

Create a link with a name:

$ gh issue artifact create 142 https://github.com/monalisa/monas-cafe/wiki/OAuth-runbook --name 'Staging OAuth runbook'

Create a document from standard input:

$ cat order-sync.log | gh issue artifact create 142 --body-file - --name 'Order sync log'

Upload an image that the document references:

$ gh issue artifact create 142 signin-plan.md --attach ./signin-flow.png

🧚 SEE ALSO 🧚

gh-issue-artifact(1) β€” go read that one next bestie πŸ’œ


that's the whole page!! mwah πŸ’‹ this one's from GitHub CLI 2.103.3, dated Oct 2026 β€” drink some water, go create an artifact, and ily 🫢✨

πŸ“¦ where this page comes from