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

Thanks 🔥

Copy link


Copy link

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.

Copy link

rm -rf is Linux/UNIX only, you shouldn't assume that we're all using Linux

Copy link

@SaSiNO97 - If you're not on a *NIX environment you are likely on Windows then, and you can use my Powershell variant I shared earlier in this thread.

Copy link

Thank you!

Copy link

Thank you. This is really helpful.

Copy link

This gist is very helpful, thanks a lot!

Copy link

Just perfect. Thank you

Copy link


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