🐡

git cleanコマンドのオプションと具体的な利用ケース

2024/12/25に公開

Git

shell

tech

概要

git cleanコマンドをちゃんと使えてない、特にオプションなど気にせず使っている
具体的な利用ケースと合わせてメモ書き

git cleanの具体的な利用ケースとオプションについて

詳しく知りたいならとにかくgit-bookを読んでみるのをおすすめする。オプションから主要な利用ケースまで解説してあるので。今回はこれに加えて個人的な利用オプションをいくつかピックアップしてメモ書きしておく

-fd の組み合わせでとにかくリセットしたい

# とにかく作業ディレクトリを掃除したい
git clean -fd

forceオプションとdirectoryオプションの組み合わせでとにかくgitにaddしていないファイル、ディレクトリを消す。手元の環境をクリーンにするために利用することが多い。Jenkinsなどでリポジトリをクローンしている際には前回ビルドの中間生成物が残っているのでそれを消し飛ばすときに使う。git reset --hardなどの差分を消すコマンドと合わせて使うことが多い。

-fX の組み合わせでgit ignoreにあるファイルを削除する

# git ignoreに登録されているファイルを削除する
git clean -fX

git ignoreに中間生成物を登録されている場合は -X オプションを使って削除する。これもCI時でクリーンするために使えるコマンド。上記とまとめて git clean -fXd として強制クリーンナップとして使うケースも多い

-fx の組み合わせでgit ignoreに関係なくすべて削除

# git ignoreに登録されているファイルもそうでないファイルもすべてcleanする
git clean -fx

git ignoreにあるファイルもないファイルもまとめてcleanする際に利用する。これも強制クリーンナップとして使う

-n, --dry-runで削除されるものを確認

# 削除されるファイルを事前に確認する
git clean -n

dry-runオプションを利用すると事前に削除するファイル、ディレクトリを確認できる。実行テストする際にはこれをつけてテストをしよう