| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 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] |
| Junio C Hamano | 9e39507 | 2008-07-31 22:11:21 | [diff] [blame] | 11 | 'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] <path>... |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
| Junio C Hamano | e91ea77 | 2009-04-26 01:41:41 | [diff] [blame] | 15 | |
| Junio C Hamano | bde411d | 2009-05-07 05:07:31 | [diff] [blame] | 16 | Cleans the working tree by recursively removing files that are not |
| 17 | under version control, starting from the current directory. |
| Junio C Hamano | e91ea77 | 2009-04-26 01:41:41 | [diff] [blame] | 18 | |
| 19 | Normally, only files unknown to git are removed, but if the '-x' |
| 20 | option is specified, ignored files are also removed. This can, for |
| 21 | example, be useful to remove all build products. |
| 22 | |
| Junio C Hamano | 9e39507 | 2008-07-31 22:11:21 | [diff] [blame] | 23 | If any optional `<path>...` arguments are given, only those paths |
| 24 | are affected. |
| Junio C Hamano | 26a5737 | 2006-05-10 00:13:40 | [diff] [blame] | 25 | |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 26 | OPTIONS |
| 27 | ------- |
| 28 | -d:: |
| 29 | Remove untracked directories in addition to untracked files. |
| Junio C Hamano | ac34f56 | 2009-08-16 19:04:05 | [diff] [blame] | 30 | If an untracked directory is managed by a different git |
| 31 | repository, it is not removed by default. Use -f option twice |
| 32 | if you really want to remove such a directory. |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 33 | |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 34 | -f:: |
| Junio C Hamano | 68cfa3a | 2009-08-30 00:22:55 | [diff] [blame] | 35 | --force:: |
| Junio C Hamano | d330432 | 2010-02-05 03:28:27 | [diff] [blame] | 36 | If the git configuration variable clean.requireForce is not set |
| 37 | to false, 'git clean' will refuse to run unless given -f or -n. |
| Junio C Hamano | 47b9acd | 2007-04-24 07:34:34 | [diff] [blame] | 38 | |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 39 | -n:: |
| Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 40 | --dry-run:: |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 41 | Don't actually remove anything, just show what would be done. |
| 42 | |
| 43 | -q:: |
| Junio C Hamano | eb41599 | 2008-06-08 22:49:47 | [diff] [blame] | 44 | --quiet:: |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 45 | Be quiet, only report errors, but not the files that are |
| 46 | successfully removed. |
| 47 | |
| 48 | -x:: |
| 49 | Don't use the ignore rules. This allows removing all untracked |
| 50 | files, including build products. This can be used (possibly in |
| Junio C Hamano | 1aa40d2 | 2010-01-21 17:46:43 | [diff] [blame] | 51 | conjunction with 'git reset') to create a pristine |
| Junio C Hamano | 60d0063 | 2006-04-05 10:34:43 | [diff] [blame] | 52 | working directory to test a clean build. |
| 53 | |
| 54 | -X:: |
| 55 | Remove only files ignored by git. This may be useful to rebuild |
| 56 | everything from scratch, but keep manually created files. |
| 57 | |
| 58 | |
| 59 | Author |
| 60 | ------ |
| 61 | Written by Pavel Roskin <proski@gnu.org> |
| 62 | |
| 63 | |
| 64 | GIT |
| 65 | --- |
| Junio C Hamano | f7c042d | 2008-06-06 22:50:53 | [diff] [blame] | 66 | Part of the linkgit:git[1] suite |
