Tomas KlingenThoughts

Git Submodules Cheatsheet

gitsubmodulescheatsheetversion-control

Git submodules let you include one Git repository inside another as a subdirectory.

Add a submodule

git submodule add https://github.com/user/repo.git path/to/submodule

Clone repo with submodules

git clone --recurse-submodules https://github.com/user/main-repo.git

Initialize submodules in existing clone

git submodule update --init --recursive

Update submodule to latest commit

cd submodule-path
git pull origin main
cd ..
git add submodule-path
git commit -m "update submodule"

Check submodule status

git submodule status
  • Clean: abc1234 path/to/submodule (v1.0)
  • Modified: +abc1234 path/to/submodule (v1.0)