GitHub CLI (gh)

This skill equips AI coding agents and human developers with clean, reliable execution patterns for GitHub CLI (gh) in Deliberate Lab. It solves terminal buffer truncation, bypasses markdown formatting bloat, and provides a unified script for viewing complete issue and PR discussions.

When to use

Invoke this skill when asked to:

• "Take a look at issue <id>"
• "What is issue <id> about?"
• "Inspect issue <id> and its comments"
• "Look at PR <id>"
• "What is PR <id> about?"
• "Read issue comments for <id>"
• "Run GitHub CLI command"
• "Check PR checks or status"

Background: The Terminal Truncation Trap

When running gh inside persistent agent terminal sessions, two subtle traps routinely corrupt output:

1. PTY / Glamour Byte Inflation: When gh outputs to a pseudo-terminal (PTY), it invokes Glamour (a terminal markdown renderer) to format headings, borders, and ANSI colors. This inflates the byte size by 12× to 16× (e.g. 6 KB of raw markdown expands to 70–100+ KB).
2. Terminal stdout 8 KB Buffer Ceiling: While view_file can read up to 45 KiB (46,080 bytes) intact, the agent harness terminal stdout (run_command) truncates from the top once output exceeds 8,192 bytes (8 KB) (<truncated N lines>), silently discarding the issue title, problem statement, and earliest comments.
3. The Non-TTY Mutual-Exclusion Trap: When piping to cat to bypass Glamour (gh issue view <id> | cat), gh treats view and view --comments as mutually exclusive:
   • gh issue view <id> | cat prints only the issue header and body.
   • gh issue view <id> --comments | cat prints only the comments (omitting the body). Neither command alone gives an agent complete context in a single call.

The helper scripts in this skill resolve all three issues cleanly: they bypass Glamour, combine threads, and automatically spill payloads exceeding 7 KB to a temporary file via mktemp with a one-liner directing the agent to inspect it intact via view_file.

Procedures

1. View an Issue (gh-issue-view.sh)

To inspect a GitHub Issue with its complete description and all comments:

./.agents/skills/gh/scripts/gh-issue-view.sh <number>

(From a sibling worktree directory, call ../.agents/skills/gh/scripts/gh-issue-view.sh <number> or from repository root).

Features:

• Command Provenance: Visibly echoes the underlying commands ($ gh issue view ... | cat) in clean plain text matching ADR 0003 before execution.
• Complete Context: Streams the issue description first, followed by the complete discussion thread.
• Compact Payload & Automatic Overflow: Emits directly to stdout if under 7 KB; if larger, saves directly to a temporary markdown file via mktemp and provides the exact path for lossless inspection via view_file.

Optional Flags:

• --no-comments: Output only the issue header and description.

  ./.agents/skills/gh/scripts/gh-issue-view.sh <number> --no-comments

• --comments-only: Output only the discussion comments thread.

  ./.agents/skills/gh/scripts/gh-issue-view.sh <number> --comments-only

2. View a Pull Request with CI Checks & Inline Reviews (gh-pr-view.sh)

In GitHub CLI, gh pr view has a major blind spot: it does not display CI check statuses, and even with --comments, it completely ignores inline code review comments left on changed files.

To inspect a Pull Request with complete metadata, CI checks, PR discussion, and line-level code reviews in a single clean payload:

./.agents/skills/gh/scripts/gh-pr-view.sh <number>

What it orchestrates:

1. Metadata & Description: $ gh pr view <id> | cat (branches, status, additions/deletions, summary).
2. CI Status & Checks: $ gh pr checks <id> | cat (lists test runs, format checks, schema validations).
3. PR Discussion: $ gh pr view <id> --comments | cat (general conversational thread).
4. Inline Code Reviews: $ gh api repos/{owner}/{repo}/pulls/<id>/comments (formats line-level review comments as [path:line] author: body).

Optional Flags:

• --checks-only: Only display CI check statuses.
• --reviews-only: Only display inline code review comments.
• --comments-only: Only display general discussion comments.
• --no-checks: Skip CI checks.
• --no-reviews: Skip inline code review comments.
• --no-comments: Skip general discussion comments.

3. The Complexity Boundary: When to Script vs. Use Raw gh

We draw a deliberate engineering boundary regarding GitHub CLI tooling:

• Dedicated Scripts for Complex Synthesis: When an operation requires synthesizing multiple fragmented endpoints or bypassing severe terminal traps (such as gh-issue-view.sh to prevent Glamour truncation and merge comments, or gh-pr-view.sh to orchestrate metadata, CI checks, discussion, and inline code reviews), use the dedicated skill scripts.
• Raw gh for Routine Commands: For standard, single-step operations (e.g. gh pr create, gh pr edit, gh issue comment), use standard gh directly without redundant wrapper layers.

4. Direct GitHub CLI Best Practices (Programmatic Tooling)

When writing automated scripts or querying GitHub CLI directly without helper scripts, follow these canons:

1. Prefer --json and --jq for Machine Consumption: When extracting specific fields, always request structured JSON rather than parsing terminal output:

   gh pr list --json number,title,headRefName,state
   gh issue view <id> --json title,body,labels -q '.title'

2. Never Run Plain gh issue view <id> --comments in a PTY: Direct terminal execution with comments will almost certainly trigger harness-level line truncation. Always use gh-issue-view.sh or pipe through cat.
3. Multi-Remote Resolution: Deliberate Lab uses a triangle workflow (origin fork, upstream canonical). Ensure a default remote is configured once:

   gh repo set-default PAIR-code/deliberate-lab

   (Bonus: This writes to .bare/config and applies globally across all sibling worktrees).
4. Fork Qualification for gh pr create: In a triangle workflow where gh repo set-default points to upstream, passing a bare --head <branch> fails with a GraphQL error because GitHub looks for <branch> on the default upstream repository. Always qualify --head with your fork username:

   gh pr create --head "$(gh api user -q .login):<branch>" --base main ...

Safety Rules

• Never allow interactive prompts: Keep export GH_PROMPT_DISABLED=1 active in non-interactive agent sessions.
• Do not shadow system binaries: Never install a silent gh wrapper into $PATH or use relative PATH modifications. Always call scripts explicitly to preserve command provenance.
• Bounded execution: Script operations are bounded by non-blocking timeouts (${GH_TIMEOUT:-5s}) per ADR 0003 Standard 6 to prevent headless credential store deadlocks.