]>
Commit | Line | Data |
---|---|---|
c3b831bd PR |
1 | git-clean(1) |
2 | ============ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-clean - Remove untracked files from the working tree | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
463ea0cf | 11 | 'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] [<pathspec>...] |
c3b831bd PR |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
911198f6 | 15 | |
6a260f53 JH |
16 | Cleans the working tree by recursively removing files that are not |
17 | under version control, starting from the current directory. | |
911198f6 | 18 | |
23f8239b | 19 | Normally, only files unknown to Git are removed, but if the `-x` |
911198f6 WL |
20 | option is specified, ignored files are also removed. This can, for |
21 | example, be useful to remove all build products. | |
22 | ||
f6a8ef07 ÆAB |
23 | If any optional `<pathspec>...` arguments are given, only those paths |
24 | that match the pathspec are affected. | |
393e3b19 | 25 | |
c3b831bd PR |
26 | OPTIONS |
27 | ------- | |
28 | -d:: | |
f6a8ef07 | 29 | Normally, when no <pathspec> is specified, git clean will not |
e86bbcf9 EN |
30 | recurse into untracked directories to avoid removing too much. |
31 | Specify -d to have it recurse into such directories as well. | |
f6a8ef07 | 32 | If a <pathspec> is specified, -d is irrelevant; all untracked |
e86bbcf9 EN |
33 | files matching the specified paths (with exceptions for nested |
34 | git directories mentioned under `--force`) will be removed. | |
c3b831bd | 35 | |
2122591b | 36 | -f:: |
f7aec129 | 37 | --force:: |
2de9b711 | 38 | If the Git configuration variable clean.requireForce is not set |
bcd57cb9 | 39 | to false, 'git clean' will refuse to delete files or directories |
105ec9ae | 40 | unless given -f. Git will refuse to modify untracked |
09487f2c EN |
41 | nested git repositories (directories with a .git subdirectory) |
42 | unless a second -f is given. | |
17696002 JX |
43 | |
44 | -i:: | |
45 | --interactive:: | |
c0be6b4c JX |
46 | Show what would be done and clean files interactively. See |
47 | ``Interactive mode'' for details. | |
105ec9ae JH |
48 | Configuration variable `clean.requireForce` is ignored, as |
49 | this mode gives its own safety protection by going interactive. | |
2122591b | 50 | |
c3b831bd | 51 | -n:: |
459cf2e9 | 52 | --dry-run:: |
c3b831bd | 53 | Don't actually remove anything, just show what would be done. |
105ec9ae | 54 | Configuration variable `clean.requireForce` is ignored, as |
12a4883f | 55 | nothing will be deleted anyway. |
c3b831bd PR |
56 | |
57 | -q:: | |
459cf2e9 | 58 | --quiet:: |
c3b831bd PR |
59 | Be quiet, only report errors, but not the files that are |
60 | successfully removed. | |
61 | ||
07de4eba JH |
62 | -e <pattern>:: |
63 | --exclude=<pattern>:: | |
407e7680 DL |
64 | Use the given exclude pattern in addition to the standard ignore rules |
65 | (see linkgit:gitignore[5]). | |
07de4eba | 66 | |
c3b831bd | 67 | -x:: |
407e7680 DL |
68 | Don't use the standard ignore rules (see linkgit:gitignore[5]), but |
69 | still use the ignore rules given with `-e` options from the command | |
70 | line. This allows removing all untracked | |
c3b831bd | 71 | files, including build products. This can be used (possibly in |
80f537f7 | 72 | conjunction with 'git restore' or 'git reset') to create a pristine |
c3b831bd PR |
73 | working directory to test a clean build. |
74 | ||
75 | -X:: | |
2de9b711 | 76 | Remove only files ignored by Git. This may be useful to rebuild |
c3b831bd PR |
77 | everything from scratch, but keep manually created files. |
78 | ||
c0be6b4c JX |
79 | Interactive mode |
80 | ---------------- | |
81 | When the command enters the interactive mode, it shows the | |
82 | files and directories to be cleaned, and goes into its | |
83 | interactive command loop. | |
84 | ||
85 | The command loop shows the list of subcommands available, and | |
86 | gives a prompt "What now> ". In general, when the prompt ends | |
87 | with a single '>', you can pick only one of the choices given | |
88 | and type return, like this: | |
89 | ||
90 | ------------ | |
91 | *** Commands *** | |
92 | 1: clean 2: filter by pattern 3: select by numbers | |
93 | 4: ask each 5: quit 6: help | |
94 | What now> 1 | |
95 | ------------ | |
96 | ||
97 | You also could say `c` or `clean` above as long as the choice is unique. | |
98 | ||
99 | The main command loop has 6 subcommands. | |
100 | ||
101 | clean:: | |
102 | ||
103 | Start cleaning files and directories, and then quit. | |
104 | ||
105 | filter by pattern:: | |
106 | ||
107 | This shows the files and directories to be deleted and issues an | |
f745acb0 | 108 | "Input ignore patterns>>" prompt. You can input space-separated |
c0be6b4c | 109 | patterns to exclude files and directories from deletion. |
5676b04a | 110 | E.g. "*.c *.h" will exclude files ending with ".c" and ".h" from |
c0be6b4c JX |
111 | deletion. When you are satisfied with the filtered result, press |
112 | ENTER (empty) back to the main menu. | |
113 | ||
114 | select by numbers:: | |
115 | ||
116 | This shows the files and directories to be deleted and issues an | |
117 | "Select items to delete>>" prompt. When the prompt ends with double | |
118 | '>>' like this, you can make more than one selection, concatenated | |
119 | with whitespace or comma. Also you can say ranges. E.g. "2-5 7,9" | |
120 | to choose 2,3,4,5,7,9 from the list. If the second number in a | |
309422e0 | 121 | range is omitted, all remaining items are selected. E.g. "7-" to |
c0be6b4c JX |
122 | choose 7,8,9 from the list. You can say '*' to choose everything. |
123 | Also when you are satisfied with the filtered result, press ENTER | |
124 | (empty) back to the main menu. | |
125 | ||
126 | ask each:: | |
127 | ||
128 | This will start to clean, and you must confirm one by one in order | |
129 | to delete items. Please note that this action is not as efficient | |
130 | as the above two actions. | |
131 | ||
132 | quit:: | |
133 | ||
563f339d | 134 | This lets you quit without doing any cleaning. |
c0be6b4c JX |
135 | |
136 | help:: | |
137 | ||
138 | Show brief usage of interactive git-clean. | |
139 | ||
16f6b0d1 ÆAB |
140 | CONFIGURATION |
141 | ------------- | |
142 | ||
143 | include::includes/cmd-config-section-all.txt[] | |
144 | ||
145 | include::config/clean.txt[] | |
146 | ||
068c6745 PO |
147 | SEE ALSO |
148 | -------- | |
149 | linkgit:gitignore[5] | |
150 | ||
c3b831bd PR |
151 | GIT |
152 | --- | |
9e1f0a85 | 153 | Part of the linkgit:git[1] suite |