Git Submodules

This is useful for adding libraries or dependencies managed in separate repositories, while keeping their commit history separate.

Submodules are helpful when you want to:

Track a library or dependency at a specific commit

To add a submodule to your project, use:

Example: Add a Submodule git submodule add https://github.com/example/library.git libs/library

When you clone a repository with submodules, you need to fetch their contents separately:

Example: Init and Update Submodules git submodule init git submodule update Or do it all at once when cloning:

Example: Clone with Submodules git clone --recurse-submodules https://github.com/user/repo.git

To see the current commit and state of your submodules, use:

You can run a command in every submodule. For example, to check their status:

To update submodules to the latest commit from their remote repository:

Example: Update All Submodules git submodule update --remote

Delete the relevant section from.gitmodules Remove the submodule directory from your working tree

About .gitmodules The.gitmodules file keeps track of all submodules and their paths. Edit this file if you move or remove submodules.

Example: .gitmodules File

If submodules are empty after cloning, run git submodule update --init --recursive.

Keep submodules for external projects you want to track at a fixed version. For simpler needs, consider alternatives like Git subtree or copying files.

Submodules are powerful, but can be tricky to manage. Only use them if you really need to track another project at a specific commit.