Git

Submodules Commands

Include and manage external repositories within your project. Submodules are essential for large projects with shared libraries or when you need to pin specific versions of dependencies.

8 commands

Pro Tips

Use 'git clone --recurse-submodules' to clone a project with all its submodules in one command.

Run 'git submodule update --init --recursive' after pulling to ensure submodules are at the correct commits.

Consider Git subtree as an alternative - it's simpler for contributors who don't need to know about the submodule.

Common Mistakes

Submodules point to specific commits, not branches. You must explicitly update them to get new changes.

Forgetting to commit submodule changes after updating them is a common mistake - always check 'git status'.

Commands

Add submodule

$ git submodule add <url> <path>

Add a git submodule.

Initialize submodules

$ git submodule init

Initialize submodule configuration.

Update submodules

$ git submodule update --init --recursive

Clone and checkout submodules.

Update submodules to latest

$ git submodule update --remote

Update submodules to latest remote.

List submodules

$ git submodule status

Show submodule status.

Clone with submodules

$ git clone --recurse-submodules <url>

Clone repo including submodules.

Remove submodule

$ git submodule deinit <path> && git rm <path>

Remove a submodule.

Execute in all submodules

$ git submodule foreach 'git pull'

Run command in each submodule.

Git