Scroll to navigation

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

NAME

gh-project - Work with GitHub Projects.

SYNOPSIS

gh project <command> [flags]

DESCRIPTION

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 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

$ 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

SEE ALSO

gh(1)

Oct 2025 GitHub CLI v2.82.1