{
    "mode": "man",
    "parameter": "GIT-BUGREPORT",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/man/GIT-BUGREPORT/json",
    "generated": "2026-10-22T13:13:17Z",
    "synopsis": "git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n[--diagnose[=<mode>]]",
    "sections": {
        "NAME": {
            "content": "git-bugreport - Collect information for user to file a bug report\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n[--diagnose[=<mode>]]\n\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Collects information about the user’s machine, Git client, and repository state, in addition\nto a form requesting information about the behavior the user observed, and stores it in a\nsingle text file which the user can then share, for example to the Git mailing list, in order\nto report an observed bug.\n\nThe following information is requested from the user:\n\n•   Reproduction steps\n\n•   Expected behavior\n\n•   Actual behavior\n\nThe following information is captured automatically:\n\n•   git version --build-options\n\n•   uname sysname, release, version, and machine strings\n\n•   Compiler-specific info string\n\n•   A list of enabled hooks\n\n•   $SHELL\n\nAdditional information may be gathered into a separate zip archive using the --diagnose\noption, and can be attached alongside the bugreport document to provide additional context to\nreaders.\n\nThis tool is invoked via the typical Git setup process, which means that in some cases, it\nmight not be able to launch - for example, if a relevant config file is unreadable. In this\nkind of scenario, it may be helpful to manually gather the kind of information listed above\nwhen manually asking for help.\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-o <path>, --output-directory <path>",
                    "content": "Place the resulting bug report file in <path> instead of the current directory.\n",
                    "flag": "-o",
                    "long": "--output-directory",
                    "arg": "<path>"
                },
                {
                    "name": "-s <format>, --suffix <format>",
                    "content": "Specify an alternate suffix for the bugreport name, to create a file named\ngit-bugreport-<formatted suffix>. This should take the form of a strftime(3) format\nstring; the current local time will be used.\n\n--no-diagnose, --diagnose[=<mode>]\nCreate a zip archive of supplemental information about the user’s machine, Git client,\nand repository state. The archive is written to the same output directory as the bug\nreport and is named git-diagnostics-<formatted suffix>.\n\nWithout mode specified, the diagnostic archive will contain the default set of statistics\nreported by git diagnose. An optional mode value may be specified to change which\ninformation is included in the archive. See git-diagnose(1) for the list of valid values\nfor mode and details about their usage.\n",
                    "flag": "-s",
                    "long": "--suffix",
                    "arg": "<format>"
                }
            ]
        },
        "GIT": {
            "content": "Part of the git(1) suite\n\nGit 2.43.0                                   07/02/2025                             GIT-BUGREPORT(1)",
            "subsections": []
        }
    },
    "summary": "git-bugreport - Collect information for user to file a bug report",
    "flags": [
        {
            "flag": "-o",
            "long": "--output-directory",
            "arg": "<path>",
            "description": "Place the resulting bug report file in <path> instead of the current directory."
        },
        {
            "flag": "-s",
            "long": "--suffix",
            "arg": "<format>",
            "description": "Specify an alternate suffix for the bugreport name, to create a file named git-bugreport-<formatted suffix>. This should take the form of a strftime(3) format string; the current local time will be used. --no-diagnose, --diagnose[=<mode>] Create a zip archive of supplemental information about the user’s machine, Git client, and repository state. The archive is written to the same output directory as the bug report and is named git-diagnostics-<formatted suffix>. Without mode specified, the diagnostic archive will contain the default set of statistics reported by git diagnose. An optional mode value may be specified to change which information is included in the archive. See git-diagnose(1) for the list of valid values for mode and details about their usage."
        }
    ],
    "examples": [],
    "see_also": [],
    "tldr": {
        "source": "official",
        "description": "Capture debug information from the system and user, generating a text file to aid in the reporting of a bug in Git.",
        "examples": [
            {
                "description": "Create a new bug report file in the current directory",
                "command": "git bugreport"
            },
            {
                "description": "Create a new bug report file in the specified directory, creating it if it does not exist",
                "command": "git bugreport {{-o|--output-directory}} {{path/to/directory}}"
            },
            {
                "description": "Create a new bug report file with the specified filename suffix in `strftime` format",
                "command": "git bugreport {{-s|--suffix}} {{%m%d%y}}"
            }
        ]
    }
}