gh pm-kit
Project management extensions for the GitHub CLI.
Installation
gh extension install srz-zumix/gh pm-kit
Shell completion
gh pm-kit supports shell completion via the completion subcommand.
Run gh pm-kit completion --help for details on how to configure it for your shell.
Usage
gh pm-kit [command] [flags]
Global flags available on all commands:
| Flag |
Default |
Description |
-L, --log-level string |
info |
Set log level: debug|info|warn|error |
--read-only |
false |
Run in read-only mode (prevent write operations) |
discussions
discussions list
List discussions in a repository.
gh pm-kit discussions list [flags]
| Flag |
Default |
Description |
--color string |
auto |
Use color in output: always|never|auto |
-R, --repo string |
current repo |
Repository in the format [HOST/]OWNER/REPO |
--format string |
|
Output format: json |
-q, --jq expression |
|
Filter JSON output using a jq expression |
-t, --template string |
|
Format JSON output using a Go template |
discussions migrate
Migrate discussions from one repository to another (supports cross-host migration).
When --number is specified, only that discussion is migrated.
When --number is omitted, all discussions are migrated.
gh pm-kit discussions migrate --dst OWNER/REPO [flags]
| Flag |
Default |
Description |
-R, --repo string |
current repo |
Source repository in the format [HOST/]OWNER/REPO |
-d, --dst string |
(required) |
Destination repository in the format [HOST/]OWNER/REPO |
-n, --number string |
|
Discussion number or URL to migrate (migrates all if omitted) |
--category string |
|
Override destination category slug (uses source category slug if omitted) |
--enable-discussions |
false |
Enable Discussions on the destination repository if not already enabled |
--overwrite |
false |
Overwrite a previously migrated discussion identified by its migration marker; without this flag, marked discussions are skipped and unmarked discussions get a new copy created |
--no-reactions |
false |
Do not embed reaction summaries into migrated discussion and comment bodies |
--color string |
auto |
Use color in output: always|never|auto |
--format string |
|
Output format: json |
-q, --jq expression |
|
Filter JSON output using a jq expression |
-t, --template string |
|
Format JSON output using a Go template |
discussions search
Search discussions in a repository using a search query.
The query can include label filters and other search criteria.
gh pm-kit discussions search [query...] [flags]
| Flag |
Default |
Description |
-R, --repo string |
current repo |
Repository in the format [HOST/]OWNER/REPO |
--owner string |
current owner |
Owner in the format [HOST/]OWNER |
-l, --label strings |
|
Filter discussions by labels (repeatable) |
--color string |
auto |
Use color in output: always|never|auto |
--format string |
|
Output format: json |
-q, --jq expression |
|
Filter JSON output using a jq expression |
-t, --template string |
|
Format JSON output using a Go template |
projects
projects list
List GitHub Projects v2 for an owner.
gh pm-kit projects list [flags]
| Flag |
Default |
Description |
-o, --owner string |
current owner |
Owner in the format [HOST/]OWNER |
--format string |
|
Output format: json |
-q, --jq expression |
|
Filter JSON output using a jq expression |
-t, --template string |
|
Format JSON output using a Go template |
projects item list
List items in a GitHub Project v2.
The project can be specified by its number or by its URL (e.g. https://github.com/orgs/my-org/projects/1).
gh pm-kit projects item list <number|URL> [flags]
| Flag |
Default |
Description |
-o, --owner string |
current owner |
Owner in the format [HOST/]OWNER |
--field strings |
TYPE,NUMBER,TITLE,URL |
Built-in fields to display: ID|TYPE|NUMBER|TITLE|AUTHOR|URL|ARCHIVED |
--custom-field strings |
|
Custom field names to display (any ProjectV2 custom field name) |
--format string |
|
Output format: json |
-q, --jq expression |
|
Filter JSON output using a jq expression |
-t, --template string |
|
Format JSON output using a Go template |
projects migrate
Migrate a GitHub Project v2 (New Projects) from one owner to another.
Copies project metadata, custom fields (TEXT, NUMBER, DATE, SINGLE_SELECT, ITERATION), and items.
Items are migrated as draft issues by default.
If --repo is specified, the migration first searches for an existing issue carrying the migration marker in that repository and links it to the project.
If no matching issue is found and --create-issue is set, a new issue is created; otherwise a draft issue is used as a fallback.
If a destination project number or URL is given as the second argument, that project is used as the migration target.
Without a destination project, a new destination project is created when needed.
Items already migrated are identified by a hidden marker and skipped by default.
gh pm-kit projects migrate <number|URL> [dst-number|dst-URL] --dst OWNER [flags]
| Flag |
Default |
Description |
-s, --src string |
current owner |
Source owner in the format [HOST/]OWNER |
-d, --dst string |
(required) |
Destination owner in the format [HOST/]OWNER (required unless a destination URL is given as the second argument) |
-r, --repo string |
|
Repository in [HOST/]OWNER/REPO format; items are linked to matching issues (by migration marker) in this repository |
--create-issue |
false |
When --repo is set and no matching issue is found, create a new issue instead of a draft issue |
--overwrite |
false |
Overwrite previously migrated content identified by the migration marker: when no destination project is given, overwrite the existing migrated project instead of skipping it; for migrated items, delete and re-create them instead of skipping them |