git-bugreport
Generate Git bug reports
TLDR
Create a new bug report file in the current directory
$ git bugreport
Create a new bug report file in the specified directory, creating it if it does not exist
$ git bugreport [[-o|--output-directory]] [path/to/directory]
Create a new bug report file with the specified filename suffix in strftime format
$ git bugreport [[-s|--suffix]] [%m%d%y]
SYNOPSIS
git bugreport [--stdout] [--suffix=<suffix>]
PARAMETERS
--stdout
Print report to stdout instead of saving to file.
--suffix=<suffix>
Filename suffix when saving (default: .txt).
DESCRIPTION
git bugreport is a Git command that creates a standardized text template for submitting bug reports. It automatically collects key diagnostic information to help developers reproduce issues, including:
- Git version and describe output
- Build platform and compiler details
- System info from uname -a
- Linux-specific /proc/version and CPU details
- Locale settings (LC_ALL, LC_CTYPE, etc.)
- Git configuration summary
The report ends with a fillable template prompting for bug description, reproduction steps, expected/actual behavior, and "bisect log" if applicable.
By default, it saves to git-bugreport-TIMESTAMP.txt in the current directory. This tool streamlines reporting to Git mailing lists, GitHub, or Git's bug tracker, reducing back-and-forth for missing details. Review the file for sensitive info before sharing.
CAVEATS
Output may contain sensitive system/user data; review before public sharing.
Requires write access to current directory for file output.
TYPICAL FILENAME
git-bugreport-YYYYMMDD_HHMMSS.txt (uses current timestamp).
HISTORY
Added in Git 1.7.1 (Jan 2010) to standardize bug reports; evolved from contrib scripts, now core for better developer support.
