TOOL » GIT

Submodule

Last updated:
Reference:man.archlinux.org

Usage ​

shell
git submodule COMMAND OPTIONS
CommandOptionDescription
addAdd a new submodule.
initInitialize (clone) new submodules, if any.
updateUpdate submodules.
update--initUpdate and initialize submodules.
update--recursiveUpdate submodules recursively (submodules inside submodules).
update--remoteUpdate submodules to the latest commit.

Example ​

Add a new submodule:

shell
git submodule add git@github.com:url_to/submodule.git path_to_submodule

Move submodule ​

shell
git mv previous/submodule target/submodule

Remove submodule ​

There is no single command for it, so a small script is needed.

shell
SUBMODULE_PATH='path/to/submodule'
git submodule deinit -f ${SUBMODULE_PATH}; rm -rf .git/modules/${SUBMODULE_PATH}; git rm -f ${SUBMODULE_PATH}