Home Explore Blog CI



git

1st chunk of `Documentation/git-clean.adoc`
8792be1fb4a045d81d05478c9ac94f27147e16c0490e3d5c0000000100000943
git-clean(1)
============

NAME
----
git-clean - Remove untracked files from the working tree

SYNOPSIS
--------
[verse]
'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] [<pathspec>...]

DESCRIPTION
-----------

Cleans the working tree by recursively removing files that are not
under version control, starting from the current directory.

Normally, only files unknown to Git are removed, but if the `-x`
option is specified, ignored files are also removed. This can, for
example, be useful to remove all build products.

If any optional `<pathspec>...` arguments are given, only those paths
that match the pathspec are affected.

OPTIONS
-------
-d::
	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 `--force`) will be removed.

-f::
--force::
	If the Git configuration variable clean.requireForce is not set
	to false, 'git clean' will refuse to delete files or directories
	unless given -f.  Git will refuse to modify untracked
	nested git repositories (directories with a .git subdirectory)
	unless a second -f is given.

-i::
--interactive::
	Show what would be done and clean files interactively. See
	``Interactive mode'' for details.
	Configuration variable `clean.requireForce` is ignored, as
	this mode gives its own safety protection by going interactive.

-n::
--dry-run::
	Don't actually remove anything, just show what would be done.
	Configuration variable `clean.requireForce` is ignored, as
	nothing will be deleted anyway.

-q::
--quiet::
	Be quiet, only report errors, but not the files that are
	successfully removed.

-e <pattern>::
--exclude=<pattern>::
	Use the given exclude pattern in addition to the standard ignore rules
	(see linkgit:gitignore[5]).

-x::
	Don't use the standard ignore rules (see linkgit:gitignore[5]), but
	still use the ignore rules given with `-e` options from the command
	line.  This allows removing all untracked
	files, including build products.  This can be used (possibly in
	conjunction with 'git restore' or 'git reset') to create a pristine
	working directory to test a clean build.

-X::
	Remove

Title: Git Clean Command
Summary
The git-clean command is used to remove untracked files from the working tree, with options to customize its behavior, such as recursing into directories, forcing removal, and ignoring certain files or patterns.