Documentation/git-clean.txt

   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]
  11 'git clean' [-d] [-f] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
  12
  13 DESCRIPTION
  14 -----------
  15
  16 Cleans the working tree by recursively removing files that are not
  17 under version control, starting from the current directory.
  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
  23 If any optional `<path>...` arguments are given, only those paths
  24 are affected.
  25
  26 OPTIONS
  27 -------
  28 -d::
  29         Remove untracked directories in addition to untracked files.
  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.
  33
  34 -f::
  35 --force::
  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.
  38
  39 -n::
  40 --dry-run::
  41         Don't actually remove anything, just show what would be done.
  42
  43 -q::
  44 --quiet::
  45         Be quiet, only report errors, but not the files that are
  46         successfully removed.
  47
  48 -e <pattern>::
  49 --exclude=<pattern>::
  50         Specify special exceptions to not be cleaned.  Each <pattern> is
  51         the same form as in $GIT_DIR/info/excludes and this option can be
  52         given multiple times.
  53
  54 -x::
  55         Don't use the ignore rules.  This allows removing all untracked
  56         files, including build products.  This can be used (possibly in
  57         conjunction with 'git reset') to create a pristine
  58         working directory to test a clean build.
  59
  60 -X::
  61         Remove only files ignored by git.  This may be useful to rebuild
  62         everything from scratch, but keep manually created files.
  63
  64
  65 Author
  66 ------
  67 Written by Pavel Roskin <proski@gnu.org>
  68
  69
  70 GIT
  71 ---
  72 Part of the linkgit:git[1] suite