How to remove untracked files in Git (2023)

During the development process, programmers and other Git users often end up with a lot of old and unwanted files. This can include prototypes, test data and computer generated files. While these files don't necessarily cause problems, deleting them increases efficiency and improves organization. This onecleanThe command is the fastest, safest and easiest way to delete these files. This guide explains how to use Git to remove untracked files and provides many examples to illustrate usage.clean.

Before using thecleancommand, you need to understand what an untracked file is and why untracked files are important. There are many types of files in any Git project. A key difference is between tracked and untracked files.

tracked fileshave already been added to Git usingadd gitCommand. Once a file is added to Git, Git is fully aware of it. It knows the details and contents of the file and can retrieve that information if needed. Tracked files can be modified or unmodified. A modified file can be provided, also with theadd gitCommand. So a tracked file can be in one of several states, but Git will still track it.

The other category of files are theuntracked filesthat have not yet been added to the repository. Git can tell these files exist, but it doesn't know anything else about them. It does not crawl your content in its internal database. Since Git doesn't actively monitor these files, it can't take any action on them. For example, it cannot restore or restore the contents of these files. These files remain untracked until added to Git usingadd gitCommand.

One danger with untracked files is that information is not saved. In case of hard disk failure or accidental deletion or overwriting, all data will be lost permanently. Since Git never saved the file, it cannot restore it.

Of course, sometimes files are not tracked because they were never meant to be added to the system. Some examples might include experimental changes, test data, discarded prototypes, build artifacts, and obsolete files. Some applications also place a large number of automatically generated files in the working directory. It would be unwise to add them to Git.

Of course, these files can be left in an untracked state and usually cause no problems. However, there is some risk in keeping old and unnecessary files untracked for the following reasons:

• It is possible accidentallyAddeForcethem, especially if you use the wildcard*Symbol.
• They clutter up a workspace and take up unnecessary disk space. This can cause confusion when you return to a workspace later. It can be difficult to remember what the files were used for and whether they are still important.
• They appear in the command output asGit-Statusas untracked files. This makes it harder to tell which files are really important.

There are several alternatives to get rid of these files. For example, you can simply delete them with thermCommand. However, this can be time-consuming and it's easy to accidentally delete the wrong file. Other alternatives likego to redefinehave a broader scope and can also unintentionally undo changes to tracked or committed files.

Also, some files shouldn't be tracked in Git, but are still important and shouldn't be deleted. A good example is a.cfgfile or create object files. In this case the.ignore.gitfile is used to tell Git to ignore this file. All files that match an exclusion rule in.ignore.gitare not displayed in the output ofGit-Statusand the various Git commands do not affect them.

It iscleanThe command is the easiest and most efficient way to remove untracked files in Git. This command is very targeted, easy to use and has no unwanted side effects. It uses the content of.ignore.gitfile and will not delete skipped files unless specifically instructed to do so. However, it is important to use this command very carefully. When a file is deleted, it is gone forever. Git cannot restore the content.

In summary, all files in a Git repository must be handled in one of three ways:

• They can be added with the repositoryadd git.
• They can be added to this.ignore.gitfile, causing Git to ignore it.
• They can be removed with a variant ofcleanCommand.

1. If you haven't already done so, create a Linode account and compute instance. see ourStarting with LinodeeCreate a compute instanceFührer.

2. follow ourConfigure and secure a compute instanceInstructions for updating your system. You can also set the time zone, configure your hostname, create a limited user account and secure SSH access.

3. It is also useful to consult our guidesIntroduction to GiteHow to Navigate the Linux Terminal and File System.

4. OptionalGit must already be installed on Linode before trying the examples in this guide. This onegitThe package is usually pre-installed. To see if it's there, run the commandgit --version🇧🇷 If Git is already installed, this command displays the current version. If Git has not yet been installed, use the commandsudo apt install gitto install it.

Use

This guide is written for non-root users. Commands that require elevated privileges are preceded by the prefixsudo🇧🇷 If you do not knowsudocommand, see theUsers and groupslead.

This section shows how to remove untracked files in Git usingcleanCommand. This command has several options that allow users to control the command's behavior or output.cleanit also has an interactive mode that makes it easy to selectively delete a subset of files.

Try the examples in this section with a local Git repository. If Linode doesn't already have a repository, you can create one using thegit initCommand. run thoseinside sideCommand in the base directory of the repository.

No additional options is the commandcleandoes nothing. One of-EU,-n, or-fOptions usually need to be appended.

clean

fatal: clean.requireForce defaults to true and neither -i, -n nor -f is specified; refuse to clean

git clean -fis probably the most common alternative. This forces Git to remove all untracked files without any further opportunity to refine or change the operation. When finished, it will show a summary of deleted files. This command is functionally equivalent to manually deleting files.

Caution

Always usecleancarefully. This action cannot be undone.

The example below shows howgit clean -fhandles a combination of untracked and tracked but uncommitted files. Before the operation,testdatei1.txtwas added but not adopted. the two filestestdatei2.txtetestdatei3.txtweren't added, so both aren't tracked in Git yet.

Git-Status

Changes to apply: New file: testfile1.txt Untracked files: testfile2.txttestfile3.txt

to runcleanUse of-fOption to delete the two untracked files.

git clean -f

Remover testfile2.txtRemove testfile3.txt

use any of theseGit-StatusorlsCommand to check if untracked files are deleted. This oneStatusThe command confirms that the tracked but uncommitted file is left intact. However, the untracked files no longer exist.

Git-Status

Changes to apply: new file: testfile1.txt

git clean -nreduces the associated riskssauberCommand. It lists all the files the command wants to delete, but it doesn't actually delete them. It acts as a "test" for the command and can be used to prevent accidental deletions.

Starting with the same setup asgit clean -nThe command lists the files that Git would "remove" in a real operation.

git clean -n

Would remove testfile2.txt Would remove testfile3.txt

After that, the files are still listed underGit-Statusbecause they weren't actually deleted.

Git-Status

...Untracked files: testfile2.txttestfile3.txt

It isgit clean -eThe option allows users to enter a specific exclusion pattern or filename. Files with this name or with this pattern will not be deleted.

In the example below, there are two untracked files calledtestfile4.mdetestdatei4.txt.

Git-Status

...Untracked files: testfile4.mdtestfile4.txt

Ignoretestdatei4.txtappend option during deletion process-e Testdatei4.txtfor thesauberCommand. East-fThe option is still required to force the remaining deletions.

git clean -f -e testfile4.txt

Remover testfile4.md

This is themdThe file is deleted, but theTXTfile is not.

...Untracked files: testfile4.txt

git clean -dis recursive and clears the current directory and all subdirectories.

git clean -f -d

Remover arquivo/testfile2.txtRemover testfile4.txt

It is also possible to specify a directory to limit the file size.cleanOperation. The command only applies to untracked files in that directory. The following example appliescleanto all filesexampleDirectory.

git clean -f -d example

git configallows users to change the default settingcleanBehavior. This allowscleanto delete untracked files without the-fPossibility. makes effectivecleanequivalentgit clean -f🇧🇷 Use the command to add this option to the configuration filegit config clean.requireForce falso🇧🇷 For more information, see the Git documentation.Clean up.

Use

It is-qoption is runningcleanin sleep mode. This meanscleandoesn't report the removed files, but still shows errors.

It is-EUThe option is used to runcleanin interactive mode. It allows users to more accurately select the files to be deleted. This is a good option for situations where you want to exclude some but not all untracked files. It's also good for anyone who wants to be extra careful when running this command.

It is-EUOption displays a menu listing all available options. It also lists files that are currently scheduled for deletion.

To switch to idle mode, run thegit sauber -iCommand. Git displays the main menu for interactive mode.

git sauber -i

Would remove the following items: testfile2.txt testfile3.md testfile3.txt*** Commands*** 1: clear 2: filter by pattern 3: select by numbers 4: ask every 5: exit 6: helpAnd now>

The list of options is as follows.

• sauber: This deletes the untracked files in the list in the same waygit clean -ftut.
• filter by default: This option allows users to enter exclusion patterns.cleanignores untracked files with names matching any of these patterns. For example, the filter pattern*.TXTsaidcleando not delete untracked files that end with.TXTRenovation.
• select by number: This displays a numbered list of untracked files. Users can use these numbers to select files for deletion.
• ask everyone: this goes through the list of untracked files one by one and allows the user to choose whether to delete each file or not.
• Go out
• Help

From the main menu, users can select one of the first four options to remove files, exit interactive mode, or view the help page.

possibility1behaves exactly like thisgit clean -f🇧🇷 It removes all untracked files and its use is self-explanatory. It is usually selected after narrowing the file list using one of the other methods. The charactercstarts this option too.

The second option isfilter by default🇧🇷 It allows users to enter a pattern. Any filename that matches this pattern will be ignored. This will limit and possibly reduce the number of filessauberoption removed.

to use thefilter by defaultfollow the steps below in the main menu.

1. choose an option2or enter thefKey. Git lists all untracked files and asks for another response.

   2

   testfile2.txt testfile3.md testfile3.txtInput ignores default>>

2. Enter the pattern you want Git to ignore. For example, to avoid deleting markdown files, enter the pattern*.md. It is*character acts as a placeholder. Any file matching this pattern will be ignored while the user remains in interactive mode. Git removes matching files from consideration and displays an updated list of eligible files.

   *.md

   testfile2.txt testfile3.txtInput ignore pattern>>

3. Add any other defaults you want Git to ignore at this point. When all patterns have been entered, use theENTERbutton to return to the main menu. Git then lists all files scheduled for deletion and waits for more entries.

   Would remove the following items: testfile2.txt testfile3.txt*** Commands*** 1: clear 2: filter by pattern 3: select by numbers 4: ask every 5: exit 6: helpAnd now>

4. To clear the file list, type1orc.

   1

   Remover testfile2.txtRemove testfile3.txt

It is often easier to specify files to exclude from a numbered list. Enter3orsto access theselect by numbersMenu. This option allows users to specify individual files, a range of files, or a wildcard.*Specification of all files. Only intentionally selected files can be deleted.

From the interactive main menu, follow these instructions to select and delete files by number.

1. Enter the option3or use theskey to enter noselect by numbersMenu.

   3

   1: Testfile2.txt 2: Testfile3.md 3: Testfile3.txt4: Testfile4.txt Select items to exclude >>

2. Enter the items to be excluded, separating them with commas. A range can also be used to select multiple consecutive items using the formatstart end🇧🇷 The following response selects elements1,2, e4, but no article3🇧🇷 Git highlights selected files with a*.

   1-2,4

   * 1: testfile2.txt * 2: testfile3.md 3: testfile3.txt * 4: testfile4.txt Select items to exclude >>

3. ChooseRETURNSto return to the main menu. Git lists selected files.

   Would remove the following items: testfile2.txt testfile3.md testfile4.txt*** Commands*** 1: clear 2: filter by pattern 3: select by numbers 4: ask every 5: exit 6: helpAnd now>

4. Enter1orcto remove selected files.

   1

   Remover testfile2.txtRemove testfile3.mdRemove testfile4.txt

The last method to delete files is theask everyonePossibility. type a4or oneoneto take advantage of this opportunity. It lists all the files one by one and asks the user if they should be deleted. answersjto delete the file ornto skip the file.

to use theask everyonemethod, follow these steps.

1. Use o4oronekey to access theask everyonePossibility.

   4

2. Git displays the first file and asks if you want to delete it or not.

   Remover testfile2.txt [s/N]?

3. Enterjto add the file to the exclusion list.

   j

4. Enterjornfor each of the remaining files.

5. After the user reviews each file, Git deletes all selected untracked files.

   Remover testfile2.txt

The remaining two options are self-explanatory. possibility5(q) exits the interactive menu. possibility6is the help menu, which can also be accessed viah🇧🇷 The help menu explains the different options.

clean - start cleaning filter by default - exclude items from deletion select by numbers - select items to delete by number ask all - confirm each deletion (like "rm -i") exit - stop cleaning help - this screen? - Quick selection help

It is.ignore.gitfile specifies which untracked files are to be ignored. This is the best option for dealing with configuration or system files that should not be checked or deleted. Users can run thelscommand and see those files, but they don't show up in the results of commands likeGit-Status🇧🇷 This file is usually created automatically and comes pre-installed with a list of common extensions that can be ignored. See the documentation for more information.ignore histo.

cleannormally ignores the files and filename patterns listed in.ignore.gitFile. This is consistent with the behavior of other Git commands, which also ignore these files by default.

However, this behavior can be overridden-xor-XPossibility. These options tell Git not to follow the default ignore rules. This means that Git can consider all files covered by.ignore.git🇧🇷 However, they differ in how they handle other untracked files.

Use

Git still respects any exclusion rules added with-ePossibility.

In the example below, all untracked*.cProject files appear inGit-Status🇧🇷 However, the*.Öfiles no. This occurs because the.ignore.gitThe file contains the pattern*.Ö🇧🇷 This tells Git to ignore files with that extension.

File: .gitignore

1

*.Ö

Usually,cleandoes not affect untracked files that match.ignore.gitSample. To usegit clean -nconfirmedtestdatei3. owill not be considered for exclusion.

git clean -n

Would remove testfile3.c. Would remove testfile3.txt. Would remove testfile4.txt

To remove only skipped files and leave other untracked files untouched, usegit clean -f -X. It is-XThe option removes the untracked.Öfiles. Developers can use this option to force a perfectly clean build.

git clean -f -X

Git only removes untracked files that match a pattern in.ignore.git.

Remover testfile3.o

Use the command to remove all untracked files regardless of whether they are skipped or notgit clean -f -xinstead. This one-xThe option removes all untracked files, including skipped files.

git clean -f -x

Remova testfile3.cRemove testfile3.oRemove testfile3.txt

This guide explains how to use it.cleanto remove untracked files in Git. While old untracked files aren't necessarily harmful, they do clog up a workspace and create a sense of clutter and chaos. There are several methods to remove them, but the easiest way to remove an untracked file in Git is thecleanCommand. This command deletes untracked files while leaving other files untouched.

It issauberThe command usually requires the force option-fbe effective. It also has a dry running mode and can run recursively.cleanfeatures a handy interactive mode that allows users to exclude files based on a predefined filter or select them from a numbered list. By default,cleanwill not delete files matching the.ignore.gitFile. However, one option only targets untracked skipped files, while another affects all untracked files. For more information about thecleanCommand, see theGit documentation.

More information

For more information on this topic, see the resources below. While they are provided in the hope that you will be helpful, please note that we cannot guarantee the accuracy or timeliness of any externally hosted material.

• Clean Git documentation
• Git ignores documentation