Skip to main content

No project description provided

Project description

gh-llm

CLI tooling for LLM-first GitHub reading and review workflows.

PyPI - Python Version pypi PyPI - Downloads LICENSE
uv ruff Gitmoji

Core Goal

gh-llm is primarily built to help an LLM quickly capture the same key context a human reviewer would get on GitHub Web, and provide actionable next commands at exactly the right places.

Key Ideas

  • Timeline-first rendering: merge comments, reviews, commits, labels, references, force-push, and state changes into one ordered stream that mirrors GitHub Web reading.
  • Real cursor pagination: use GitHub GraphQL first/after and last/before, so page expansion always pulls real server-side data instead of fake local slicing.
  • Progressive context loading: show first + last page first (high-signal summary), then expand hidden pages/events only when needed.
  • Action-oriented output: place ready-to-run gh / gh-llm commands at decision points (expand, view detail, reply, resolve, review).
  • Stateless interaction model: no fragile local session state required between commands.

Requirements

  • Python 3.14+
  • gh installed and authenticated (gh auth status)

Install

uv tool install gh-llm
gh-llm --help

Quick Start

PR Reading

# Show first + last timeline pages with actionable hints
gh-llm pr view 77900 --repo PaddlePaddle/Paddle

# Expand one hidden timeline page
gh-llm pr timeline-expand 2 --pr 77900 --repo PaddlePaddle/Paddle

# Show full content for one event index
gh-llm pr event 15 --pr 77900 --repo PaddlePaddle/Paddle

# Expand resolved review details in batch
gh-llm pr review-expand PRR_xxx,PRR_yyy --pr 77900 --repo PaddlePaddle/Paddle

# Checks
gh-llm pr checks --pr 77900 --repo PaddlePaddle/Paddle
gh-llm pr checks --pr 77900 --repo PaddlePaddle/Paddle --all

Issue Reading

gh-llm issue view 77924 --repo PaddlePaddle/Paddle
gh-llm issue timeline-expand 2 --issue 77924 --repo PaddlePaddle/Paddle
gh-llm issue event 6 --issue 77924 --repo PaddlePaddle/Paddle

Comment / Thread Actions

# Edit comment
gh-llm pr comment-edit IC_xxx --body '<new_body>' --pr 77900 --repo PaddlePaddle/Paddle
gh-llm issue comment-edit IC_xxx --body '<new_body>' --issue 77924 --repo PaddlePaddle/Paddle

# Reply / resolve / unresolve review thread
gh-llm pr thread-reply PRRT_xxx --body '<reply>' --pr 77900 --repo PaddlePaddle/Paddle
gh-llm pr thread-resolve PRRT_xxx --pr 77900 --repo PaddlePaddle/Paddle
gh-llm pr thread-unresolve PRRT_xxx --pr 77900 --repo PaddlePaddle/Paddle

PR Review Workflow

1) Start from diff hunks

gh-llm pr review-start --pr 77938 --repo PaddlePaddle/Paddle

It prints per-hunk anchor lines and ready-to-run comment/suggestion commands.

2) Add inline comment

gh-llm pr review-comment \
  --path 'paddle/phi/api/include/compat/torch/library.h' \
  --line 106 \
  --side RIGHT \
  --body 'Please add a regression test for duplicate keyword arguments.' \
  --pr 77938 --repo PaddlePaddle/Paddle

3) Add inline suggestion

gh-llm pr review-suggest \
  --path 'path/to/file' \
  --line 123 \
  --side RIGHT \
  --body 'Suggested update' \
  --suggestion 'replacement_code_here' \
  --pr 77938 --repo PaddlePaddle/Paddle

4) Submit review

gh-llm pr review-submit \
  --event COMMENT \
  --body 'Overall feedback...' \
  --pr 77938 --repo PaddlePaddle/Paddle

Submit behavior:

  • If you already have a pending review on this PR, review-submit submits that pending review.
  • Otherwise, it creates and submits a new review.

This supports the normal flow where one review contains multiple inline comments.

Render Conventions

  • PR/Issue metadata is rendered as frontmatter.
  • PR description uses <pr_description>...</pr_description>.
  • Issue description uses <issue_description>...</issue_description>.
  • Comment body uses <comment>...</comment> to avoid markdown fence ambiguity.
  • Hidden timeline sections are separated by --- and include expand commands.

Development

uv run ruff check
uv run pyright
uv run pytest -q

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gh_llm-0.1.0.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gh_llm-0.1.0-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file gh_llm-0.1.0.tar.gz.

File metadata

  • Download URL: gh_llm-0.1.0.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gh_llm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 40d31d4cc808d1e60982671d286a18ffab9bce31e6523b6c13b20e477fe460bb
MD5 303b5b70d125a06637b9c31984c5102c
BLAKE2b-256 82fba6caf7a08104987ab26aa67fa69a52688f3978099408a92fa3629f26d430

See more details on using hashes here.

Provenance

The following attestation bundles were made for gh_llm-0.1.0.tar.gz:

Publisher: release.yml on ShigureLab/gh-llm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gh_llm-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: gh_llm-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gh_llm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23ad8b45c2f9c5ba92a140771a801de9df4492136604899e7612b88a7ffbac5a
MD5 2bc26ca86d1bf1f246649cbd8540e51d
BLAKE2b-256 16af3269ccf94bd7b7df82bd12ef0c5adc8609166c365fce42de4bbd157937b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for gh_llm-0.1.0-py3-none-any.whl:

Publisher: release.yml on ShigureLab/gh-llm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page