Git:Submodules

lastmod 2026-02-24created 2016-03-204 edits

Command

git submodule add {repository_url}

Adds a submodule.

git submodule init

Initializes. Must be run after a repository clone.

git submodule update

Updates the modules that have changed.

Remove submodule

• Stackoverflow: How do I remove a submodule?

To remove a submodule:

1. Delete the relevant section from the .gitmodules file.
2. Stage the .gitmodules changes git add .gitmodules
3. Delete the relevant section from .git/config.
4. Run git rm --cached path_to_submodule (no trailing slash).
5. Run rm -rf .git/modules/path_to_submodule
6. Commit git commit -m "Removed submodule {name}"
7. Delete the now untracked submodule files
8. rm -rf path_to_submodule

See also

• Subtree

Favorite site

• 7.11 Git Tools - Submodules
• Using GIT Submodule (Nested Repository)
• Adding/removing external GIT modules, and the later-added submodule deinit command
• How to use git submodule
• Git's magic files | GeekNews
  • [Original] Git’s Magic Files | Andrew Nesbitt