1GIT-DIAGNOSE(1)                   Git Manual                   GIT-DIAGNOSE(1)
2
3
4

NAME

6       git-diagnose - Generate a zip archive of diagnostic information
7

SYNOPSIS

9       git diagnose [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
10                      [--mode=<mode>]
11

DESCRIPTION

13       Collects detailed information about the user’s machine, Git client, and
14       repository state and packages that information into a zip archive. The
15       generated archive can then, for example, be shared with the Git mailing
16       list to help debug an issue or serve as a reference for independent
17       debugging.
18
19       By default, the following information is captured in the archive:
20
21git version --build-options
22
23       •   The path to the repository root
24
25       •   The available disk space on the filesystem
26
27       •   The name and size of each packfile, including those in alternate
28           object stores
29
30       •   The total count of loose objects, as well as counts broken down by
31           .git/objects subdirectory
32
33       Additional information can be collected by selecting a different
34       diagnostic mode using the --mode option.
35
36       This tool differs from git-bugreport(1) in that it collects much more
37       detailed information with a greater focus on reporting the size and
38       data shape of repository contents.
39

OPTIONS

41       -o <path>, --output-directory <path>
42           Place the resulting diagnostics archive in <path> instead of the
43           current directory.
44
45       -s <format>, --suffix <format>
46           Specify an alternate suffix for the diagnostics archive name, to
47           create a file named git-diagnostics-<formatted suffix>. This should
48           take the form of a strftime(3) format string; the current local
49           time will be used.
50
51       --mode=(stats|all)
52           Specify the type of diagnostics that should be collected. The
53           default behavior of git diagnose is equivalent to --mode=stats.
54
55           The --mode=all option collects everything included in --mode=stats,
56           as well as copies of .git, .git/hooks, .git/info, .git/logs, and
57           .git/objects/info directories. This additional information may be
58           sensitive, as it can be used to reconstruct the full contents of
59           the diagnosed repository. Users should exercise caution when
60           sharing an archive generated with --mode=all.
61

GIT

63       Part of the git(1) suite
64
65
66
67Git 2.39.1                        2023-01-13                   GIT-DIAGNOSE(1)
Impressum