gh-project(1)

Usage

gh project <command> [flags]

Overview

Work with GitHub Projects.

The minimum required scope for the token is: project. You can verify your token scope by running gh auth status and add the project scope by running gh auth refresh -s project.

Available commands

`gh-project-close(1)`	Close a project
`gh-project-copy(1)`	Copy a project
`gh-project-create(1)`	Create a project
`gh-project-delete(1)`	Delete a project
`gh-project-edit(1)`	Edit a project
`gh-project-field-create(1)`	Create a field in a project
`gh-project-field-delete(1)`	Delete a field in a project
`gh-project-field-list(1)`	List the fields in a project
`gh-project-item-add(1)`	Add a pull request or an issue to a project
`gh-project-item-archive(1)`	Archive an item in a project
`gh-project-item-create(1)`	Create a draft issue item in a project
`gh-project-item-delete(1)`	Delete an item from a project by ID
`gh-project-item-edit(1)`	Edit an item in a project
`gh-project-item-list(1)`	List the items in a project
`gh-project-link(1)`	Link a project to a repository or a team
`gh-project-list(1)`	List the projects for an owner
`gh-project-mark-template(1)`	Mark a project as a template
`gh-project-unlink(1)`	Unlink a project from a repository or a team
`gh-project-view(1)`	View a project

Exit status

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.

Examples

$ gh project create --owner monalisa --title "Roadmap"
$ gh project view 1 --owner cli --web
$ gh project field-list 1 --owner cli
$ gh project item-list 1 --owner cli

Releases

2 releases since Debian 13 (Trixie); the text changed 1 time.

13
Arch

Referred to by