README

Summarize GitHub pull requests and commits using OpenAI

Index

• Requirements
• Installation
• Setup
• Usage

Requirements

• PHP >= 8.1

Installation

Install GitHub summarizer via the below command:

composer global require stevebauman/github-summarizer

Setup

GitHub Summarizer will prompt you for an OpenAI token the first time you attempt to summarize local commits, as well as a GitHub token the first time you attempt to summarize a pull request.

Usage

Local Git Commit Summarization

Summarize local git commits in the current working directory:

summarize here {files?} {--all}

Pull Request Summarization

Summarize a GitHub pull request:

summarize pr {org}/{repo} {--number=} {--state=open} {--style=changelog}

List all open PR's for selection:

summarize pr laravel/framework

List all closed PR's for selection:

summarize pr laravel/framework --state=closed

Summarize a specific PR by its number:

summarize pr laravel/framework 1234

Summarize a specific PR by its number responding in a "commit" style:

summarize pr laravel/framework 1234 --style=commit

Commit Summarization:

Summarize a GitHub commit or range of commits:

summarize commit {org}/{repo} {sha} {--from=} {--to=} {--style=changelog}

List recent commits to summarize:

summarize commit laravel/framework

List recent commits in a specific branch to summarize:

summarize commit laravel/framework --branch=10.x

Summarize a specific commit:

summarize commit laravel/framework {sha}

Summarize a specific commit responding in a "commit" style:

summarize commit laravel/framework {sha} --style=commit

Summarize a range of commits from the tagged version to master:

summarize commit laravel/framework --from=v10.0.1

Summarize a range of commits from the tagged version to another tagged version:

summarize commit laravel/framework --from=v10.0.1 --to=v10.0.2

Summarize a range of commits:

summarize commit laravel/framework --from={sha} --to={sha}

Summarize a range of commits (from the given commit to master)

summarize commit laravel/framework --from={sha}