ワーキングディレクトリーやステージングエリアからファイルを削除するコマンドの説明
「git rm」コマンドは、「ワーキングディレクトリー」や「ステージングエリア」からファイルを削除するコマンドです。「ステージングエリア」から削除されたファイルは、次回コミット時「スナップショット」に格納されなくなります。
補足
トラックされていないファイルは削除対象外です。コマンドのフォーマット
コマンドのフォーマットは以下のようになります。
git rm <オプション> <ファイル名>
このコマンドの基本的な使い方は、以下を参考にしてください。
実行テストに関するオプション
実行テストに関するオプションです。いずれのオプションも省略できます。
実行テストを行う(-n, --dry-run)
コマンドの実行テストを行います。このオプションを指定すると、どのファイルが削除されるのか、事前に確認することができます。
このオプションの使用例は、「ワーキングディレクトリーやステージングエリアから削除されるファイルを確認する」を参考にしてください。
ファイルの削除に関するオプション
ファイルの削除に関するオプションです。いずれのオプションも省略できます。
フォルダー内の全てのファイルを削除する(-r)
フォルダー内の全てのファイルを削除します。「ファイル名」オプションにフォルダー名を指定する場合は、このオプションを指定します。
このオプションの使用例は、「フォルダー内のすべてのファイルを、ワーキングディレクトリーとステージングエリアから削除する」を参考にしてください。
ファイルを強制的に削除する(-f, --force)
編集されているファイルなど、「チェックアウト」後に操作を行ったファイルは削除できません。このオプションを指定すれば、強制的にファイルを削除することができます。
このオプションの使用例は、「ワーキングディレクトリーやステージングエリアからファイルを強制的に削除する」を参考にしてください。
ファイルをステージングエリアから削除する(--cached)
ファイルを「ステージングエリア」から削除します。「ワーキングディレクトリー」内のファイルは削除されず、トラックされていないファイルになります。
このオプションの使用例は、「ファイルをステージングエリアから削除する」を参考にしてください。
その他のオプション
その他のオプションです。削除するファイルがなくても、コマンドの戻り値に0を返す(--ignore-unmatch)
削除するファイルがなくても、コマンドの戻り値に0を返します。シェルスクリプトから「git rm」コマンドを呼び出す時に利用します。
メッセージの出力を抑制する(-q, --quiet)
このオプションを指定すると、削除するファイルの一覧を表示しません。ファイル名
「ワーキングディレクトリー」や「ステージングエリア」から削除するファイルのファイル名を指定します。複数のファイルを指定する場合は、スペース区切りでファイル名を指定します。
ファイル名にスペースが含まれる場合など、ファイル名を正しく認識させるには、「'」でファイル名を括ってください。
例:'test.txt'
パスの指定について
サブフォルダー以下のファイルを指定する場合は、パスの記述を行います。例:src/main.c
ファイル名を明示する場合は
コマンドのオプションとファイル名が同じ場合など、ファイル名の指定であることを明示するには、「--」オプションをファイル名の前に記述します。「ファイル名の指定を明示して、ワーキングディレクトリーやステージングエリアからファイルを削除する」を参考にしてください。
ワイルドカードによる指定
ワイルドカードによる指定も可能です。例えば、「'*.txt'」のように記述することも可能です。
ワイルドカードによるファイル名の指定は、「ワイルドカードを利用して、ワーキングディレクトリーやステージングエリアからファイルを削除する」を参考にしてください。
フォルダーの指定も可能
「ファイル名」にフォルダーを指定することもできます。フォルダーを指定すると、フォルダー内の全てのファイルが対象になります。
再帰的に、フォルダー内のフォルダーも対象にすることもできます。
特定のサブフォルダーを指定したい場合は、ファイル同様パス付きでフォルダーを指定してください。
フォルダーの指定は、「フォルダー内のすべてのファイルを、ワーキングディレクトリーとステージングエリアから削除する」を参考にしてください。