LinuxCommandLibrary

gh-issue-create

Create new GitHub issues

TLDR

Create a new issue against the current repository interactively

$ gh issue create
copy

Create a new issue with the bug label interactively
$ gh issue create [[-l|--label]] "[bug]"
copy

Create a new issue interactively and assign it to the specified users
$ gh issue create [[-a|--assignee]] [user1,user2,...]
copy

Create a new issue with a title, body and assign it to the current user
$ gh issue create [[-t|--title]] "[title]" [[-b|--body]] "[body]" [[-a|--assignee]] "[@me]"
copy

Create a new issue interactively, reading the body text from a file
$ gh issue create [[-F|--body-file]] [path/to/file]
copy

Create a new issue in the default web browser
$ gh issue create [[-w|--web]]
copy

Display the help
$ gh issue create --help
copy

SYNOPSIS

gh issue create [flags]

PARAMETERS

--assignee
    Assign people by their login to the issue

--body
    Supply a body. Will prompt if not given.

--editor
    Add body using editor. Will prompt if not given.

--label
    Add labels by name to the issue

--project
    Add the issue to projects by name

--repo /
    Specify another repository using the '[OWNER]/[REPO]' format.

--title
    Supply a title. Will prompt if not given.

DESCRIPTION

The `gh issue create` command simplifies the process of creating new issues in a GitHub repository directly from your terminal. It streamlines issue submission by allowing you to set the title, body, and other metadata for the issue via command-line arguments or interactively through prompts. This tool is especially useful for developers who prefer working within a terminal-centric workflow and want to quickly report bugs, suggest enhancements, or track tasks without leaving their development environment. The command automatically associates the new issue with the current repository if you are in a git repository folder, or you can specify a repository.

CAVEATS

Requires the `gh` CLI to be installed and authenticated with a GitHub account. The user must have permission to create issues in the target repository.

INTERACTIVE MODE

If the `--title` and `--body` flags are not provided, `gh issue create` will launch an interactive prompt, guiding the user through the process of providing the required information. This mode is useful when you are unsure of the issue's details or want to refine them before submitting.

EDITOR INTEGRATION

The `--editor` flag allows you to compose the issue body in your default text editor. After you save and close the editor, the content will be used as the issue body.

HISTORY

The `gh issue create` command is part of the GitHub CLI tool (`gh`), which was developed by GitHub to improve the developer experience when interacting with GitHub repositories. It was introduced to provide a command-line alternative to using the GitHub web interface for common tasks like issue creation. Its development has been focused on making GitHub workflows more accessible from the terminal.

SEE ALSO

gh(1), gh issue list(1), gh issue view(1)

Copied to clipboard