{
    "content": [
        {
            "type": "text",
            "text": "# git-bugreport (man)\n\n## NAME\n\ngit-bugreport - Collect information for user to file a bug report\n\n## SYNOPSIS\n\ngit bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n\n## DESCRIPTION\n\nCaptures information about the user’s machine, Git client, and repository state, as well as a\nform requesting information about the behavior the user observed, into a single text file\nwhich the user can then share, for example to the Git mailing list, in order to report an\nobserved bug.\n\n## TLDR\n\n> Capture debug information from the system and user, generating a text file to aid in the reporting of a bug in Git.\n\n- Create a new bug report file in the current directory:\n  `git bugreport`\n- Create a new bug report file in the specified directory, creating it if it does not exist:\n  `git bugreport {{-o|--output-directory}} {{path/to/directory}}`\n- Create a new bug report file with the specified filename suffix in `strftime` format:\n  `git bugreport {{-s|--suffix}} {{%m%d%y}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (2 subsections)\n- **GIT**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "git-bugreport",
        "section": "",
        "mode": "man",
        "summary": "git-bugreport - Collect information for user to file a bug report",
        "synopsis": "git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]",
        "tldr_summary": "Capture debug information from the system and user, generating a text file to aid in the reporting of a bug in Git.",
        "tldr_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}}"
            }
        ],
        "tldr_source": "official",
        "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."
            }
        ],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 30,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-o <path>, --output-directory <path>",
                        "lines": 2,
                        "flag": "-o",
                        "long": "--output-directory",
                        "arg": "<path>"
                    },
                    {
                        "name": "-s <format>, --suffix <format>",
                        "lines": 4,
                        "flag": "-s",
                        "long": "--suffix",
                        "arg": "<format>"
                    }
                ]
            },
            {
                "name": "GIT",
                "lines": 5,
                "subsections": []
            }
        ],
        "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\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "Captures information about the user’s machine, Git client, and repository state, as well as a\nform requesting information about the behavior the user observed, into a single text file\nwhich the user can then share, for example to the Git mailing list, in order to report an\nobserved 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\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",
                        "flag": "-s",
                        "long": "--suffix",
                        "arg": "<format>"
                    }
                ]
            },
            "GIT": {
                "content": "Part of the git(1) suite\n\n\n\nGit 2.34.1                                   02/26/2026                             GIT-BUGREPORT(1)",
                "subsections": []
            }
        }
    }
}