Skip to content

How to remove a submodule in Git?

junwufan edited this page Feb 9, 2022 · 2 revisions

Removing a submodule is useful when it is no longer required. The steps below outline the removal of a submodule.

Remove Submodule

  1. Remove the submodule entry from .git/config
    git submodule deinit -f path/to/submodule
  1. Remove the submodule directory from the superproject's .git/modules directory
    rm -rf .git/modules/path/to/submodule # linux
    rd /s /q .git/modules/path/to/submodule # windows
    Remove-Item -Force -Recurse .git/modules/path/to/submodule #powershell
  1. Remove the entry in .gitmodules and remove the submodule directory located at path/to/submodule
    git rm -f path/to/submodule