gh-iteration

gh iteration

GitHub CLI extension to list/view/edit iterations in GitHub Projects.

Index

Commands

Command Description
gh iteration field-list List the iteration fields in a project
gh iteration field-view View an iteration field
gh iteration item-edit Edit iteration of a project item
gh iteration item-view View a project item
gh iteration items-edit Edit iteration of multiple project items
gh iteration list List the iterations for an iteration field

Installation

1. Install GitHub CLI (gh)

See the document.

2. Install gh-iteration

gh extension install tasshi-me/gh-iteration

3. Refresh token with project scope (if required)

To access to GitHub Projects, your token must have project scope.

You can check current your token scopes by:

$ gh auth status

If project is not in token scopes, add project scope by:

$ gh auth refresh -s project

Examples

# Set current iteration to the project items that match the query condition.
$ gh iteration items-edit \
    --owner <OWNER> \
    --project <PROJECT_NUM> \
    --field <FIELD_NAME> \
    --query "Items.Fields.Status.Name == \"In progress\"" \
    --iteration-current