@pleaseai/gh-please

GitHub CLI extension - GitHub tools for LLMs

English | 한국어

Overview

@pleaseai/gh-please is a powerful GitHub CLI extension that enhances issue and PR management.

Core Features (Built-in)

• gh CLI Passthrough: All GitHub CLI commands available through gh-please with optional TOON/JSON format
• Issue Management: Issue types, sub-issues, dependencies, and worktree-based development workflow
• PR Management: Review comment replies, thread resolution, comment editing
• LLM-Friendly Output: JSON, TOON (58.9% token reduction) format support across all commands
• Multilingual: Automatic Korean/English detection
• Plugin System: Extensible architecture

Latest Updates (v0.18.0)

• 🚀 gh CLI Passthrough - Access all 100+ GitHub CLI commands through gh-please
• ✨ TOON Format Support - 58.9% token reduction for LLM-friendly output across all list commands
• ✨ Automatic Format Conversion - Convert any gh command output to TOON or JSON format
• ✨ ID Converter Utility - Support both Database ID and Node ID for comment operations
• ✨ PR Review Thread List - Display review threads with Node IDs and copy-ready resolve commands
• ✨ E2E Testing - Comprehensive end-to-end test coverage (26 tests, 100% pass rate)
• ✨ Comment Management - List and edit Issue/PR comments with flexible ID formats

Quick Start

Installation

gh extension install pleaseai/gh-please

CI / Docker (no authentication needed): gh extension install uses the GitHub API, whose unauthenticated rate limit (60 req/hour per IP) is easily exhausted on shared CI runners — gh then reports the HTTP 403 as an auth error. Use the standalone installer, which downloads the binary from the public release CDN with no token:

curl -fsSL https://raw.githubusercontent.com/pleaseai/gh-please/main/scripts/install.sh | bash

Prefer gh extension install in CI? Set GH_TOKEN (e.g. ${{ github.token }} in GitHub Actions) to lift the rate limit.

Get Started in 5 Minutes

# Issue management
gh please issue create --title "Fix bug" --type Bug
gh please issue sub-issue create 100 --title "Sub-task"
gh please issue dependency add 200 --blocked-by 199
gh please issue develop 123  # Auto-create worktree

# Issue types
gh please issue type list
gh please issue type set 123 --type Feature
gh please issue type remove 123

# PR management
gh please pr review reply 1234567890 -b "Fixed!"        # Database ID
gh please pr review reply PRRC_kwDOABC123 -b "Fixed!"    # Node ID also supported
gh please pr review thread list 456              # List threads with Node IDs
gh please pr review thread list 456 --unresolved-only
gh please pr review thread resolve 456 --all

# Comment management
gh please issue comment list 123 --format json
gh please issue comment edit 987654321 --body "Updated"  # Requires --issue option
gh please pr review comment edit 987654321 --body "Updated" --pr 456

Key Features

🔄 gh CLI Passthrough

gh-please automatically supports all GitHub CLI commands through passthrough:

# Any gh command works through gh-please
gh please repo view
gh please workflow list
gh please release view v1.0.0

# Convert output to TOON format (58.9% token reduction)
gh please issue list --format toon
gh please issue view 123 --format toon      # View commands supported!
gh please pr view 456 --format toon
gh please pr checks 123 --format toon
gh please workflow list --format toon
gh please repo view --format toon

# Get JSON for automation
gh please pr list --format json
gh please issue view 123 --format json      # Auto-injects required fields
gh please repo view --format json

How it works:

• Unregistered commands automatically forward to gh CLI
• --format toon converts JSON output to TOON format (58.9% token savings)
• --format json preserves JSON output
• No format flag → preserve gh CLI's original table output
• Works with all gh commands that support --json flag
• View commands: Auto-injects required fields (e.g., issue view, pr view, repo view)

Benefits:

• ✅ Complete gh CLI coverage - Access all 100+ gh commands
• ✅ LLM-friendly - TOON format optimized for AI/automation
• ✅ Automatic field injection - View commands work seamlessly
• ✅ Automatic updates - New gh CLI features work immediately
• ✅ Zero learning curve - Use familiar gh commands

Passthrough Documentation →

Issue Development Workflow

# Create isolated workspace for issue
gh please issue develop 123
# → Creates ~/.please/worktrees/repo/feat-123-feature

# Cleanup after work
gh please issue cleanup

Detailed Workflow Guide →

Issue Type Management

# Create issue with type
gh please issue create --title "Login bug" --type Bug

# List available issue types
gh please issue type list
gh please issue type list --json name,color

# Set/update issue type
gh please issue type set 123 --type Feature

# Remove issue type
gh please issue type remove 123

Sub-Issue Management

# Hierarchical issue structure
gh please issue sub-issue create 100 --title "Task 1"
gh please issue sub-issue list 100 --format markdown

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗