Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
How effectively delete a git submodule.

To remove a submodule you need to:

  • Delete the relevant section from the .gitmodules file.
  • Stage the .gitmodules changes git add .gitmodules
  • Delete the relevant section from .git/config.
  • Run git rm --cached path_to_submodule (no trailing slash).
  • Run rm -rf .git/modules/path_to_submodule (no trailing slash).
  • Commit git commit -m "Removed submodule "
  • Delete the now untracked submodule files rm -rf path_to_submodule
Copy link

slo-addy commented Jun 2, 2022

Life saver! Thank you.

Copy link

jairusjoer commented Aug 11, 2022

Thanks 🔥

Copy link

coeneivan commented Sep 18, 2022


Copy link

panozzaj commented Sep 22, 2022

Building on the answers above...

If you're doing this a lot, you can create an executable script discoverable in your PATH named git-submodule-remove with the following contents:

Then you can run git submodule-remove path/to/submodule to quickly remove it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment