git-check-ignore(1) — Linux manual page


GIT-CHECK-IGNORE(1)            Git Manual            GIT-CHECK-IGNORE(1)

NAME         top

       git-check-ignore - Debug gitignore / exclude files

SYNOPSIS         top

       git check-ignore [<options>] <pathname>...
       git check-ignore [<options>] --stdin

DESCRIPTION         top

       For each pathname given via the command-line or from a file via
       --stdin, check whether the file is excluded by .gitignore (or
       other input files to the exclude mechanism) and output the path
       if it is excluded.

       By default, tracked files are not shown at all since they are not
       subject to exclude rules; but see ‘--no-index’.

OPTIONS         top

       -q, --quiet
           Don’t output anything, just set exit status. This is only
           valid with a single pathname.

       -v, --verbose
           Instead of printing the paths that are excluded, for each
           path that matches an exclude pattern, print the exclude
           pattern together with the path. (Matching an exclude pattern
           usually means the path is excluded, but if the pattern begins
           with "!" then it is a negated pattern and matching it means
           the path is NOT excluded.)

           For precedence rules within and between exclude sources, see

           Read pathnames from the standard input, one per line, instead
           of from the command-line.

           The output format is modified to be machine-parsable (see
           below). If --stdin is also given, input paths are separated
           with a NUL character instead of a linefeed character.

       -n, --non-matching
           Show given paths which don’t match any pattern. This only
           makes sense when --verbose is enabled, otherwise it would not
           be possible to distinguish between paths which match a
           pattern and those which don’t.

           Don’t look in the index when undertaking the checks. This can
           be used to debug why a path became tracked by e.g.  git add .
           and was not ignored by the rules as expected by the user or
           when developing patterns including negation to match a path
           previously added with git add -f.

OUTPUT         top

       By default, any of the given pathnames which match an ignore
       pattern will be output, one per line. If no pattern matches a
       given path, nothing will be output for that path; this means that
       path will not be ignored.

       If --verbose is specified, the output is a series of lines of the

       <source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>

       <pathname> is the path of a file being queried, <pattern> is the
       matching pattern, <source> is the pattern’s source file, and
       <linenum> is the line number of the pattern within that source.
       If the pattern contained a "!" prefix or "/" suffix, it will be
       preserved in the output. <source> will be an absolute path when
       referring to the file configured by core.excludesFile, or
       relative to the repository root when referring to
       .git/info/exclude or a per-directory exclude file.

       If -z is specified, the pathnames in the output are delimited by
       the null character; if --verbose is also specified then null
       characters are also used instead of colons and hard tabs:

       <source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname>

       If -n or --non-matching are specified, non-matching pathnames
       will also be output, in which case all fields in each output
       record except for <pathname> will be empty. This can be useful
       when running non-interactively, so that files can be
       incrementally streamed to STDIN of a long-running check-ignore
       process, and for each of these files, STDOUT will indicate
       whether that file matched a pattern or not. (Without this option,
       it would be impossible to tell whether the absence of output for
       a given file meant that it didn’t match any pattern, or that the
       output hadn’t been generated yet.)

       Buffering happens as documented under the GIT_FLUSH option in
       git(1). The caller is responsible for avoiding deadlocks caused
       by overfilling an input buffer or reading from an empty output

EXIT STATUS         top

           One or more of the provided paths is ignored.

           None of the provided paths are ignored.

           A fatal error was encountered.

SEE ALSO         top

       gitignore(5) git-config(1) git-ls-files(1)

GIT         top

       Part of the git(1) suite

COLOPHON         top

       This page is part of the git (Git distributed version control
       system) project.  Information about the project can be found at
       ⟨⟩.  If you have a bug report for this manual
       page, see ⟨⟩.  This page was obtained
       from the project's upstream Git repository
       ⟨⟩ on 2024-06-14.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2024-06-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Git         2024-06-12            GIT-CHECK-IGNORE(1)

Pages that refer to this page: git(1)gitignore(5)