Git - Clean

Git is an important tool for developers, enabling effective source code management and collaboration. Enter the git clean command—a powerful tool that helps you keep your working directory clean and organized. In this article, we'll explore what git clean does, how to use it safely, and its importance in managing your projects efficiently.

What is git clean?

git clean is a Git command that helps you remove untracked files and directories from your working directory. These untracked files are those that are not being tracked by Git, meaning they are not part of your repository's version history. They might be generated during development, such as build unique, temporary files, or files you decided not to commit.

Why Use git clean?

Over time, a repository can accumulate many untracked files, leading to clutter and potential confusion. Using git clean helps you:

1. Maintain a tidy Repository: Remove unnecessary files to keep your working directory clean and organized.
2. Avoid Mistakes: Ensure that you don't accidentally commit unwanted files.
3. Optimize Performance: Improve the efficiency of your repository by eliminating excess files.

How to Use `git clean` Safely

Before running git clean, it's crucial to understand its potential impact. Since it permanently deletes files, caution is necessary. Here are some steps to use git clean safely:

1. Preview the Changes

Before removing any files, use the -n or --dry-run option to preview what will be deleted:

git clean -n

This command lists all the files and directories that git clean would remove, giving you a chance to review and ensure that no important files are included.

2. Remove Untracked Files

Once you've reviewed the files, you can proceed with the actual cleanup by using the -f or --force option:

git clean -f

3. Remove Untracked Directories

If you also want to remove untracked directories, use the -d option along with -f:

git clean -fd

4. Interactively Remove Files

For a more controlled cleanup, use the -i or --interactive option. This allows you to select which files to remove interactively:

git clean -i

5. Remove Ignored Files

To remove files that are listed in your .gitignore, use the -X option:

git clean -fx

Git Clean Examples

There are certain limitations associated which are as follows: 

By default, it will not remove:

• the .gitignore files
• new directories which are created recently
• index files.
• existing commit files

Let us pictorially depict the above commands and interpret them via terminal/PowerShell as follows:  

Example 1: Using "git clean"

Example 2: Using "git clean -n"

Example 3: Using "git clean --force"

Example 4: Using "git status" (To check the status of files)

Example 5: Using "git clean -fdx"

Git Clean Common Options 

There are so many options available with git clean and each and every option has its own features. Below are some options specified. 

1. Git clean dry run: Before executing the "git clean" command it is preferred to do a dry run. Through this, you will get to know what type of files are going to be cleaned because of the "git clean" command.

Command:

git clean --dry-run

2. Git clean force: The untracked files in the git can't be cleaned by using the git clean command. In that case, we need to do force clean then git will remove all the untracked files also.

Command: 

git clean --force 

3. Git clean ignored: Git clean ignored will help you to clean or remove the files which are ignored by git.

git clean --ignored

4. Git clean interactive: Git clean interactive will ask you before deleting or removing files for confirmation. This will avoid unfortunate deleting.

git clean --interactive

5. Git clean directories: By using "--force" will remove only the untracked files if you want to remove all the directories then the following command will help you to do that.

git clean --directories

Be aware of the "git clean" command it will delete or remove the files permanently. Check twice before executing the command it will huge loss for the organization if some important files are deleted.

Git Clean Up

By cleaning git you improve the performance of git and the size of the repository will be decreased. By using the following steps you can clean your git repositories.

1. Prune remote branches: Once the remote branches are deleted or no longer needed, by using the following command you can remove references to those branches from the local repository. Helps in keeping sync with the remote repository.

git remote prune <Alias name of remote repository>

2. Remove merged branches: If sub-branches are merged into the main branch there will;l less use of those branches you can delete those branches. For that, you use the following command.

git branch -d <branch_name>

3. Delete local and remote tags: After merging sub-branches into main branches there is no use of the tags also. You can delete those tags with the help of the following.

For deleting local tags:

git tag -d <tag_name> 

For deleting remote tags: 

git push --delete origin <tag_name>

4. Clean untracked files: The main purpose of the git clean command is to remove untracked files and directories from the working directory. Take a backup before executing the following command.

git clean

Git Clean fd

If you want to remove the directories which are not tracked by git forcibly then we can use the option "-fd". 

git clean -fd

"- f" is force "-d" represents directories while executing the "-fd" make sure you have taken a backup of the directories. Make sure you use the dry run option by this you get to know which files are actually going to be affected.

Interactive Mode Or Git Clean Interactive

When we execute the git clean command it will clean all the files and directories which are not tracked by git with put any interaction. If you use the --interaction option when you execute the git clean option you produce a prompt and ask for confirmation before removing the files and directories. 

git clean --interactive

It is highly recommended to use the interactive option. It shows the files and directories which are going to be removed or deleted.  

Git Clean Advantages

Git clean command had lots of advantages. They are:

1. Removing untracked files: Git Clean is mainly used to remove the files and directories which are untacked by git. By removing the untracked files you can keep your workspace clean.
2. More flexible: We can use multiple options with the git clean command which helps in different ways. Like -d to remove the directories, --ignored to remove the ignored file by git.
3. Improves the performance: If the untracked files and directories are more performance of the git repository will be decreased. Using the "git clean" command helps you to delete all the untracked files.
4. Clean up space: Siza of the repository will reduce after removing untracked files. The repository is more manageable and contains only tracked files.

Git Clean Command Limitations

Git clean command will help you delete the untracked files permanently but there are some limitations with the git clean command. They are 

1. Files will delete permanently: Untacked files and directories will be deleted permanently from the working directory. we can't undo the files and directories are deleted. You need to take a backup before executing the git clean command.
2. The scope is limited: Git clean command is not able to remove the files and directories which are already tracked by git. If the files are in ignored directories you need some additional options to remove them like --ignored etc.
3. No default interaction: Git clean command will delete all the files and directories without any warning. If you want any warning prompt then you need to use some options with git clean, like "--interactive".
4. Can't remove directories: By default git clean cant remove or delete directories. For deleting directories you need to use some options like "--directories".

Conclusion

Git clean command will remove and delete all the unracked files permanently. This will help you to reduce the size of the repository and will help you to manage the repository more organized way. Git Clean can be combined with git rest to completely undo all commits and additions in a repository.