SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsgh-tool

gh-tool

Coding & development

View repository

Updated 10-15 17:27

About this skill

gh-tool (GitHub)

GitHub CLI wrapper — PRs, issues, workflows, checks, reviews, merge. Part of @blogic-cz/agent-tools.

How to Run

Run via bun gh-tool (requires @blogic-cz/agent-tools as a dev dependency). NEVER run bare gh — the credential guard will block it. Auth: gh auth login or GITHUB_TOKEN env var.

Discover commands

bun gh-tool commands dumps the entire command tree (every subcommand + its flags, types, choices, descriptions) as one structured payload — fetch it once instead of running --help repeatedly. Every agent-tools CLI has a commands subcommand (e.g. bun db-tool commands, bun k8s-tool commands).

PR Commands

Use --repo <profile|owner/name> when working outside a single-repo checkout. If a repository has a PR template, prefer --body-stdin with a literal heredoc for pr create and pr edit; use --body-file only when the filled file already exists.

bun gh-tool pr list --state open                         # List PRs (filter: --author/--base/--head/--search)
bun gh-tool pr status                  # View PR status for current branch
bun gh-tool pr view --pr 123           # View PR details
bun gh-tool pr view --prs 12,34,56     # Batch view several PRs in one call (also: pr checks --prs)
bun gh-tool pr checks --pr 123         # Check CI status (one-shot snapshot)
bun gh-tool pr checks --pr 123 --watch # Watch CI until complete or --timeout (default 600s); returns a snapshot on timeout
bun gh-tool pr wait-mergeable --pr 123 # Poll until GitHub gives a definitive mergeable verdict
bun gh-tool pr checks-failed --pr 123 --with-logs # Failure diagnosis + SHA evidence
bun gh-tool pr watch --prs 123,124 --format jsonl --timeout 600 # Multi-PR transition stream
bun gh-tool pr close --pr 123 --comment "Closing, no longer needed" --delete-branch
bun gh-tool pr draft --pr 123            # Convert an open PR to draft
bun gh-tool pr ready --pr 123            # Mark a draft PR ready for review
bun gh-tool pr merge --pr 123 --strategy squash --delete-branch --confirm
bun gh-tool pr stack view --pr 123    # Every PR in the GitHub stack containing this one, bottom-up
bun gh-tool pr stack merge --pr 123 --strategy squash --confirm # Merge the whole stack in one request
bun gh-tool pr stack unstack --pr 123 --confirm # Dissolve the stack, removing every unmerged member
bun gh-tool pr threads --pr 123 --unresolved-only  # Review comments
bun gh-tool pr request-review --repo be --pr 123 --reviewers alice,bob # Request/re-request review; newlyRequested vs alreadyPending tells whether a fresh request was created
bun gh-tool pr reply --pr 123 --comment-id 456 --body "Fixed"
bun gh-tool pr edit-comment --comment-id 456 --body-file correction.md # Edit your own inline review comment
bun gh-tool pr edit-comment --comment-id 789 --kind issue --pr 123 --body "Corrected detail"
bun gh-tool pr resolve --thread-id 789
bun gh-tool pr create --repo be --title "feat: X" --body-stdin <<'EOF'
## Summary

...

## Testing

- bun run check
EOF
bun gh-tool pr edit --repo be --pr 123 --body-stdin <<'EOF'
## Summary

...

## Testing

- bun run check
EOF
bun gh-tool pr review-triage --pr 123  # Combined info+threads+checks; leads with a `ready` merge-readiness verdict
bun gh-tool pr reply-and-resolve --comment-id 456 --body "Done" # Infer PR + thread
bun gh-tool pr reply-and-resolve --pr 123 --comment-id 456 --thread-id 789 --body "Done" # Explicit IDs validated first
bun gh-tool pr rerun-checks --pr 123 --failed-only --watch --timeout 600 # Attempt-aware rerun
bun gh-tool pr trigger-checks --pr 123 --workflow dotnet-pull-request.yml # Zero checks reported: dispatch on the PR head branch and verify the run matches it
bun gh-tool pr feedback --pr 123 --only visible-open --exclude-authors github-actions # Narrowed inventory; `omitted` says what was dropped
bun gh-tool pr review --pr 123 --event comment --body "Notes, no verdict" # Create + submit a review in one call
bun gh-tool pr review --pr 123 --event request-changes --body-stdin --confirm # Blocking verdict; body required
bun gh-tool pr review --pr 123 --event approve --confirm # Body optional
bun gh-tool pr submit-review --pr 123 --event request-changes --confirm # Same verdict on an already-pending review

--event approve and --event request-changes require --confirm, the same gate as pr merge, because both change whether the PR can merge. --event comment needs no gate but does need a body. GitHub refuses a verdict on your own PR; use --event comment there.

Zero threads can mean the reviewer is still drafting. A pending review is invisible to the API until submit, and its comments keep their draft time in createdAt. reviewId says which comments arrived together; join it to reviews[].submittedAt from pr feedback for the exact time that batch became visible, or read updatedAt as a proxy that also moves on edits. Never conclude from createdAt that an earlier scan missed something.

Gist commands

bun gh-tool gist list                         # List your gists
bun gh-tool gist view --id <gist-id>          # View files and content
bun gh-tool gist create --files a.ts          # Create a secret gist
bun gh-tool gist edit --id <gist-id> --desc X # Edit without opening $EDITOR
bun gh-tool gist delete --id <gist-id>        # Dry-run; add --confirm to delete

Use --body or --body-file with --filename for inline content. Add --public to create a public gist. gist list/view use the GitHub API and return structured output.

Workflow Commands

bun gh-tool workflow list                              # List recent workflow runs
bun gh-tool workflow view --run 123                    # View run details with jobs/steps
bun gh-tool workflow watch --run 123                   # Block until run completes or --timeout (default 600s); NO sleep-polling!
bun gh-tool workflow logs --run 123                    # Fetch logs (failed jobs by default)
bun gh-tool workflow job-logs --run 123 --job "build"  # Clean parsed logs for specific job
bun gh-tool workflow rerun --run 123                   # Rerun failed jobs
bun gh-tool workflow cancel --run 123                  # Cancel in-progress run

NEVER use sleep N && workflow list/jobs/view — use workflow watch --run N instead. The credential guard blocks sleep-polling with agent-tools commands.

Issue Commands

bun gh-tool issue list --state open --limit 30
bun gh-tool issue view --issue 123
bun gh-tool issue close --issue 123 --reason completed --comment "Done"
bun gh-tool issue reopen --issue 123
bun gh-tool issue comment --issue 123 --body "text"
bun gh-tool issue edit --issue 123 --title "New title" --add-labels bug
bun gh-tool issue triage --issue 123 --verbosity full --format json

Branch Commands

bun gh-tool branch rename --old-name feature/old --new-name feature/new          # Dry-run
bun gh-tool branch rename --old-name feature/old --new-name feature/new --confirm # Execute
bun gh-tool branch rename --old-name feature/old --new-name feature/new --repo owner/repo --confirm

Tips

  • Use bun gh-tool commands for the full machine-readable command/flag tree; --help for one subcommand.
  • Output defaults to TOON (token-efficient) — leave it as-is to save tokens. Add --format json only when you'll machine-parse output; JSON/JSONL modes suppress informational stderr but preserve structured errors.
  • checks-failed --with-logs returns diagnosis. rerun-checks preflights all attempt jobs/logs and performs one --failed mutation per workflow run; evidence_unavailable and escalation_required mutate nothing. Discovery runs only with --watch, and discovery/watch share --timeout.
  • Zero reported checks is a state, not an error — every checks read returns [] for it. When no run exists at all (GitHub dropped the pull_request event), use pr trigger-checks; never workflow run without a ref, which dispatches on the default branch and goes green for the wrong commit. Treat matchesPrHead: false and checksObserved: false as "not evidence".
  • Feedback SHA/origin fields and JSONL event schema are defined canonically in README gh-tool machine contracts. jobId is the workflow job database ID and is omitted when unavailable, as are runId and attempt; checkId is no longer emitted. pre_existing means different known commit, not obsolete.
  • Error responses include hint, nextCommand, and retryable fields — always check them on failure.
  • Prefer CLI tool over MCP tools — more efficient, doesn't load extra context.