git clean

In diesem Beispiel wird ein neues Git-Repository im Verzeichnis git_clean_test erstellt. Anschließend wird eine tracked_file erstellt und dem Index hinzugefügt. Zusätzlich werden eine untracked_file und ein untracked_dir angelegt. In dem Beispiel wird dann git status ausgeführt, woraufhin der interne Git-Status von verfolgten und nicht verfolgten Änderungen angezeigt wird. In diesem Repository-Zustand können wir git clean ausführen, um zu zeigen, was dieser Befehl bewirkt.

An dieser Stelle kann der Standard-Befehl git clean einen schwerwiegenden Fehler verursachen. Das Beispiel oben zeigt, wie das aussehen kann. Die globale Konfiguration von Git sieht vor, dass git clean standardmäßig mit der Option "force" ausgeführt wird. Das ist ein wichtiger Sicherheitsmechanismus. Wenn git clean am Ende ausgeführt wird, ist es nicht mehr rückgängig zu machen. Wird es vollständig ausgeführt, bewirkt git clean ein hartes Löschen des Dateisystems, ähnlich wie durch Ausführen der Befehlszeilenoption "rm". Stelle also sicher, dass du die nicht verfolgten Dateien löschen willst, bevor du den Befehl ausführst.

Nachdem wir erklärt haben, was mit git clean normalerweise geschieht und was zu beachten ist, wollen wir nun ein paar Anwendungsfälle für git clean und die dafür erforderlichen Befehlszeilenoptionen veranschaulichen.

Die Option -n führt einen "Probelauf" mit git clean durch. So siehst du, welche Dateien entfernt werden, ohne dass sie tatsächlich entfernt werden. Ein Probelauf von git clean ist eine bewährte Methode. Diese Option lässt sich anhand unseres zuvor erstellten Demo-Repositorys demonstrieren.

Anhand des Outputs erkennen wir, dass die untracked_file beim Ausführen von git clean entfernt wird. Beachte, dass untracked_dir hier nicht genannt wird. git clean wird standardmäßig nicht rekursiv auf Verzeichnisse angewendet. Auch das ist ein Sicherheitsmechanismus, der dafür sorgt, dass nichts versehentlich dauerhaft gelöscht wird.

Die Option "force" leitet die Löschung nicht verfolgter Dateien vom aktuellen Verzeichnis aus ein. Wenn die Konfigurationsoption clean.requireForce auf "false" gesetzt ist, musst du "force" nicht verwenden. Die in der Datei .gitignore angegebenen nicht verfolgten Ordner und Dateien werden nicht entfernt. Führen wir git clean direkt einmal in unserem Beispiel-Repository aus.

Auf den Befehl hin werden die gelöschten Dateien ausgegeben. Wie du sehen kannst, ist die untracked_file entfernt worden. Führst du an dieser Stelle git status aus oder gibst ls ein, wird angezeigt, dass untracked_file gelöscht worden und nicht zu finden ist. git clean -f wird standardmäßig auf alle nicht verfolgten Dateien im aktuellen Verzeichnis angewendet. Zusätzlich kannst du einen < path >-Wert zur Option -f eingeben, um eine bestimmte Datei zu löschen.

Mit der Option -d wird git clean mitgeteilt, dass du nicht verfolgte Verzeichnisse entfernen willst. Standardmäßig werden Verzeichnisse hierbei ignoriert. Wir können die Option -d zu unseren vorherigen Beispielen hinzufügen:

Hier haben wir mithilfe der Kombination -dn einen Testdurchlauf ausgeführt. Seine Ausgabe besagt, dass das Entfernen von untracked_dir ansteht. Dann führen wir eine erzwungene Bereinigung durch und erhalten als Ausgabe, dass untracked_dir entfernt wird.

Ein gängiges Muster für Software-Releases ist ein Build- oder Distributionsverzeichnis, das nicht in den Verfolgungsindex der Repositorys übertragen wird. Das Build-Verzeichnis enthält vorübergehende Build-Artefakte, die aus einem committeten Quellcode generiert werden. Dieses Build-Verzeichnis wird normalerweise der .gitignore-Datei nachholen. Es kann sinnvoll sein, dieses Verzeichnis auch mit anderen nicht verfolgten Dateien zu bereinigen. Die Option -x weist git clean an, auch alle ignorierten Dateien einzubeziehen. Wie bei vorherigen git clean-Aufrufen ist es empfehlenswert, vor dem endgültigen Löschen zunächst einen Testlauf durchzuführen. Die Option -x wird auf alle ignorierten Dateien angewendet und nicht nur Projekt-Build-spezifische. Dies könnten unbeabsichtigte Dinge wie ./.idea IDE-Konfigurationsdateien sein.

Die Option -x kannst du, wie auch -d, zusammen mit anderen Optionen anwenden und kombinieren. In dieser Verbindung mit -f werden aus dem aktuellen Verzeichnis nicht verfolgte Dateien sowie auch all die Dateien entfernt, die Git normalerweise ignoriert.

Neben einzelnen Befehlen, die wir bisher ausgeführt haben, verfügt git clean auch über einen "interaktiven" Modus, den du mit der Option -i einleiten kannst. Werfen wir einen Blick zurück auf das Beispiel-Repository vom Anfang. In diesem anfänglichen Zustand starten wir eine interaktive Bereinigungssitzung.

Da wir die interaktive Sitzung mit der Option -d eingeleitet haben, wird dabei auch unser untracked_dir einbezogen. Im interaktiven Modus wirst du mit What now> dazu aufgefordert, einen Befehl auf die nicht verfolgten Dateien anzuwenden. Die Befehle selbst sind selbsterklärend. Werfen wir einen kurzen Blick darauf und beginnen wir einfach mal mit dem Befehl 6: help. Wenn du Befehl 6 auswählst, werden die anderen Befehl anschließend erklärt:

Es liegt auf der Hand: Dieser Befehl beendet die interaktive Sitzung.

So kannst du die angegebenen Elemente löschen. Wenn wir 1: clean an dieser Stelle ausführen, wird untracked_dir/ untracked_file entfernt.

wird für jede nicht verfolgte Datei wiederholt. Zum Löschen erscheint eine Y/N (Ja/Nein)-Aufforderung. Das sieht in etwa so aus:

Zeigt eine zusätzliche Eingabeaufforderung an, die Eingaben zum Filtern der Liste mit nicht verfolgten Dateien entgegennimmt.

Hier folgen wir dem Muster des Platzhalters *_file. Daraufhin wird die Liste nicht verfolgter Dateien auf untracked_dir beschränkt.

Mit Befehl 3 kannst du, ähnlich wie mit Befehl 2, mehr Informationen zur Namensliste der nicht verfolgten Dateien anzeigen lassen. Bei der interaktiven Sitzung werden Zahlen zu den Namen der nicht verfolgten Dateien ausgegeben.

Zur Erinnerung: git clean ist ein praktischer Befehl zum Entfernen nicht verfolgter Dateien im Arbeitsverzeichnis eines Repositorys. Nicht verfolgte Dateien sind Dateien im Arbeitsverzeichnis deines Repositorys, die noch nicht per git add dem Index deines Repositorys hinzugefügt wurden. Mit git clean erzielst du im Allgemeinen dasselbe Ergebnis, als würdest du git status und die nativen Tools zum Entfernen verwenden, die dein Betriebssystem dir bietet. Wenn du git clean und git reset miteinander kombinierst, kannst du sämtliche Ergänzungen und Commits in einem Repository vollständig rückgängig machen.