gh-project - Man Page

• List projects owned by the currently authenticated user: gh project [ls|list]
• List projects owned by a specific user or organization: gh project [ls|list] --owner owner
• View a project by number: gh project view number --owner owner
• Create a new project: gh project create --owner owner --title project_title
• Add an item (issue or pull request) to a project: gh project item-add number --owner owner --url issue_or_pr_url
• List items in a project: gh project item-list number --owner owner
• Close a project: gh project close number --owner owner

tldr.sh

gh project <command> [flags]

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.

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

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.

$ 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

gh(1)

gh(1), gh-project-close(1), gh-project-copy(1), gh-project-create(1), gh-project-delete(1), gh-project-edit(1), gh-project-field-create(1), gh-project-field-delete(1), gh-project-field-list(1), gh-project-item-add(1), gh-project-item-archive(1), gh-project-item-create(1), gh-project-item-delete(1), gh-project-item-edit(1), gh-project-item-list(1), gh-project-link(1), gh-project-list(1), gh-project-mark-template(1), gh-project-unlink(1), gh-project-view(1).