man1/git-clean.1

   1 '\" t
   2 .\"     Title: git-clean
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.176.gd6c51973e4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CLEAN" "1" "2023\-09\-13" "Git 2\&.42\&.0\&.176\&.gd6c519" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-clean \- Remove untracked files from the working tree
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit clean\fR [\-d] [\-f] [\-i] [\-n] [\-q] [\-e <pattern>] [\-x | \-X] [\-\-] [<pathspec>\&...]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 Cleans the working tree by recursively removing files that are not under version control, starting from the current directory\&.
  41 .sp
  42 Normally, only files unknown to Git are removed, but if the \fB\-x\fR option is specified, ignored files are also removed\&. This can, for example, be useful to remove all build products\&.
  43 .sp
  44 If any optional \fB<pathspec>\&.\&.\&.\fR arguments are given, only those paths that match the pathspec are affected\&.
  45 .SH "OPTIONS"
  46 .PP
  47 \-d
  48 .RS 4
  49 Normally, when no <pathspec> is specified, git clean will not recurse into untracked directories to avoid removing too much\&. Specify \-d to have it recurse into such directories as well\&. If a <pathspec> is specified, \-d is irrelevant; all untracked files matching the specified paths (with exceptions for nested git directories mentioned under
  50 \fB\-\-force\fR) will be removed\&.
  51 .RE
  52 .PP
  53 \-f, \-\-force
  54 .RS 4
  55 If the Git configuration variable clean\&.requireForce is not set to false,
  56 \fIgit clean\fR
  57 will refuse to delete files or directories unless given \-f or \-i\&. Git will refuse to modify untracked nested git repositories (directories with a \&.git subdirectory) unless a second \-f is given\&.
  58 .RE
  59 .PP
  60 \-i, \-\-interactive
  61 .RS 4
  62 Show what would be done and clean files interactively\&. See \(lqInteractive mode\(rq for details\&.
  63 .RE
  64 .PP
  65 \-n, \-\-dry\-run
  66 .RS 4
  67 Don\(cqt actually remove anything, just show what would be done\&.
  68 .RE
  69 .PP
  70 \-q, \-\-quiet
  71 .RS 4
  72 Be quiet, only report errors, but not the files that are successfully removed\&.
  73 .RE
  74 .PP
  75 \-e <pattern>, \-\-exclude=<pattern>
  76 .RS 4
  77 Use the given exclude pattern in addition to the standard ignore rules (see
  78 \fBgitignore\fR(5))\&.
  79 .RE
  80 .PP
  81 \-x
  82 .RS 4
  83 Don\(cqt use the standard ignore rules (see
  84 \fBgitignore\fR(5)), but still use the ignore rules given with
  85 \fB\-e\fR
  86 options from the command line\&. This allows removing all untracked files, including build products\&. This can be used (possibly in conjunction with
  87 \fIgit restore\fR
  88 or
  89 \fIgit reset\fR) to create a pristine working directory to test a clean build\&.
  90 .RE
  91 .PP
  92 \-X
  93 .RS 4
  94 Remove only files ignored by Git\&. This may be useful to rebuild everything from scratch, but keep manually created files\&.
  95 .RE
  96 .SH "INTERACTIVE MODE"
  97 .sp
  98 When the command enters the interactive mode, it shows the files and directories to be cleaned, and goes into its interactive command loop\&.
  99 .sp
 100 The command loop shows the list of subcommands available, and gives a prompt "What now> "\&. In general, when the prompt ends with a single \fI>\fR, you can pick only one of the choices given and type return, like this:
 101 .sp
 102 .if n \{\
 103 .RS 4
 104 .\}
 105 .nf
 106     *** Commands ***
 107         1: clean                2: filter by pattern    3: select by numbers
 108         4: ask each             5: quit                 6: help
 109     What now> 1
 110 .fi
 111 .if n \{\
 112 .RE
 113 .\}
 114 .sp
 115 .sp
 116 You also could say \fBc\fR or \fBclean\fR above as long as the choice is unique\&.
 117 .sp
 118 The main command loop has 6 subcommands\&.
 119 .PP
 120 clean
 121 .RS 4
 122 Start cleaning files and directories, and then quit\&.
 123 .RE
 124 .PP
 125 filter by pattern
 126 .RS 4
 127 This shows the files and directories to be deleted and issues an "Input ignore patterns>>" prompt\&. You can input space\-separated patterns to exclude files and directories from deletion\&. E\&.g\&. "*\&.c *\&.h" will excludes files end with "\&.c" and "\&.h" from deletion\&. When you are satisfied with the filtered result, press ENTER (empty) back to the main menu\&.
 128 .RE
 129 .PP
 130 select by numbers
 131 .RS 4
 132 This shows the files and directories to be deleted and issues an "Select items to delete>>" prompt\&. When the prompt ends with double
 133 \fI>>\fR
 134 like this, you can make more than one selection, concatenated with whitespace or comma\&. Also you can say ranges\&. E\&.g\&. "2\-5 7,9" to choose 2,3,4,5,7,9 from the list\&. If the second number in a range is omitted, all remaining items are selected\&. E\&.g\&. "7\-" to choose 7,8,9 from the list\&. You can say
 135 \fI*\fR
 136 to choose everything\&. Also when you are satisfied with the filtered result, press ENTER (empty) back to the main menu\&.
 137 .RE
 138 .PP
 139 ask each
 140 .RS 4
 141 This will start to clean, and you must confirm one by one in order to delete items\&. Please note that this action is not as efficient as the above two actions\&.
 142 .RE
 143 .PP
 144 quit
 145 .RS 4
 146 This lets you quit without do cleaning\&.
 147 .RE
 148 .PP
 149 help
 150 .RS 4
 151 Show brief usage of interactive git\-clean\&.
 152 .RE
 153 .SH "CONFIGURATION"
 154 .sp
 155 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
 156 .PP
 157 clean\&.requireForce
 158 .RS 4
 159 A boolean to make git\-clean do nothing unless given \-f, \-i or \-n\&. Defaults to true\&.
 160 .RE
 161 .SH "SEE ALSO"
 162 .sp
 163 \fBgitignore\fR(5)
 164 .SH "GIT"
 165 .sp
 166 Part of the \fBgit\fR(1) suite