]>
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] | |
17696002 | 11 | 'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>... |
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 | |
2de9b711 | 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 | ||
f448e24e AMS |
23 | If any optional `<path>...` arguments are given, only those paths |
24 | are affected. | |
393e3b19 | 25 | |
c3b831bd PR |
26 | OPTIONS |
27 | ------- | |
28 | -d:: | |
29 | Remove untracked directories in addition to untracked files. | |
2de9b711 | 30 | If an untracked directory is managed by a different Git |
a0f4afbe JH |
31 | repository, it is not removed by default. Use -f option twice |
32 | if you really want to remove such a directory. | |
c3b831bd | 33 | |
2122591b | 34 | -f:: |
f7aec129 | 35 | --force:: |
2de9b711 | 36 | If the Git configuration variable clean.requireForce is not set |
bcd57cb9 MR |
37 | to false, 'git clean' will refuse to delete files or directories |
38 | unless given -f, -n or -i. Git will refuse to delete directories | |
39 | with .git sub directory or file unless a second -f | |
40 | is given. This affects also git submodules where the storage area | |
41 | of the removed submodule under .git/modules/ is not removed until | |
42 | -f is given twice. | |
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. | |
2122591b | 48 | |
c3b831bd | 49 | -n:: |
459cf2e9 | 50 | --dry-run:: |
c3b831bd PR |
51 | Don't actually remove anything, just show what would be done. |
52 | ||
53 | -q:: | |
459cf2e9 | 54 | --quiet:: |
c3b831bd PR |
55 | Be quiet, only report errors, but not the files that are |
56 | successfully removed. | |
57 | ||
07de4eba JH |
58 | -e <pattern>:: |
59 | --exclude=<pattern>:: | |
b6194678 JH |
60 | In addition to those found in .gitignore (per directory) and |
61 | $GIT_DIR/info/exclude, also consider these patterns to be in the | |
62 | set of the ignore rules in effect. | |
07de4eba | 63 | |
c3b831bd | 64 | -x:: |
b6194678 JH |
65 | Don't use the standard ignore rules read from .gitignore (per |
66 | directory) and $GIT_DIR/info/exclude, but do still use the ignore | |
67 | rules given with `-e` options. This allows removing all untracked | |
c3b831bd | 68 | files, including build products. This can be used (possibly in |
0b444cdb | 69 | conjunction with 'git reset') to create a pristine |
c3b831bd PR |
70 | working directory to test a clean build. |
71 | ||
72 | -X:: | |
2de9b711 | 73 | Remove only files ignored by Git. This may be useful to rebuild |
c3b831bd PR |
74 | everything from scratch, but keep manually created files. |
75 | ||
c0be6b4c JX |
76 | Interactive mode |
77 | ---------------- | |
78 | When the command enters the interactive mode, it shows the | |
79 | files and directories to be cleaned, and goes into its | |
80 | interactive command loop. | |
81 | ||
82 | The command loop shows the list of subcommands available, and | |
83 | gives a prompt "What now> ". In general, when the prompt ends | |
84 | with a single '>', you can pick only one of the choices given | |
85 | and type return, like this: | |
86 | ||
87 | ------------ | |
88 | *** Commands *** | |
89 | 1: clean 2: filter by pattern 3: select by numbers | |
90 | 4: ask each 5: quit 6: help | |
91 | What now> 1 | |
92 | ------------ | |
93 | ||
94 | You also could say `c` or `clean` above as long as the choice is unique. | |
95 | ||
96 | The main command loop has 6 subcommands. | |
97 | ||
98 | clean:: | |
99 | ||
100 | Start cleaning files and directories, and then quit. | |
101 | ||
102 | filter by pattern:: | |
103 | ||
104 | This shows the files and directories to be deleted and issues an | |
f745acb0 | 105 | "Input ignore patterns>>" prompt. You can input space-separated |
c0be6b4c JX |
106 | patterns to exclude files and directories from deletion. |
107 | E.g. "*.c *.h" will excludes files end with ".c" and ".h" from | |
108 | deletion. When you are satisfied with the filtered result, press | |
109 | ENTER (empty) back to the main menu. | |
110 | ||
111 | select by numbers:: | |
112 | ||
113 | This shows the files and directories to be deleted and issues an | |
114 | "Select items to delete>>" prompt. When the prompt ends with double | |
115 | '>>' like this, you can make more than one selection, concatenated | |
116 | with whitespace or comma. Also you can say ranges. E.g. "2-5 7,9" | |
117 | to choose 2,3,4,5,7,9 from the list. If the second number in a | |
309422e0 | 118 | range is omitted, all remaining items are selected. E.g. "7-" to |
c0be6b4c JX |
119 | choose 7,8,9 from the list. You can say '*' to choose everything. |
120 | Also when you are satisfied with the filtered result, press ENTER | |
121 | (empty) back to the main menu. | |
122 | ||
123 | ask each:: | |
124 | ||
125 | This will start to clean, and you must confirm one by one in order | |
126 | to delete items. Please note that this action is not as efficient | |
127 | as the above two actions. | |
128 | ||
129 | quit:: | |
130 | ||
131 | This lets you quit without do cleaning. | |
132 | ||
133 | help:: | |
134 | ||
135 | Show brief usage of interactive git-clean. | |
136 | ||
068c6745 PO |
137 | SEE ALSO |
138 | -------- | |
139 | linkgit:gitignore[5] | |
140 | ||
c3b831bd PR |
141 | GIT |
142 | --- | |
9e1f0a85 | 143 | Part of the linkgit:git[1] suite |