Scroll to navigation

GH-PROJECT-ITEM-EDIT(1) GitHub CLI manual GH-PROJECT-ITEM-EDIT(1)

NAME

gh-project-item-edit - Edit an item in a project

SYNOPSIS

gh project item-edit [flags]

DESCRIPTION

Edit either a draft issue or a project item. Both usages require the ID of the item to edit.

For non-draft issues, the ID of the project is also required, and only a single field value can be updated per invocation.

Remove project item field value using --clear flag.

OPTIONS

Body of the draft issue item

Remove field value

Date value for the field (YYYY-MM-DD)

ID of the field to update

Output format: {json}

ID of the item to edit

ID of the iteration value to set on the field

Filter JSON output using a jq expression

Number value for the field

ID of the project to which the field belongs to

ID of the single select option value to set on the field

Format JSON output using a Go template; see "gh help formatting"

Text value for the field

Title of the draft issue item

EXAMPLE

# edit an item's text field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --text "new text"
# clear an item's field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --clear

SEE ALSO

gh-project(1)

Apr 2024 GitHub CLI v2.48.0