Skip to Content

git submodule

Manages repositories embedded inside another repository as submodules.

Syntax

git submodule [<options>] [<subcommand>]

Options

add <repository> [<path>]: Adds a new submodule
init: Initializes submodules recorded in .gitmodules
update: Clones and checks out submodules to their recorded commits
--init --recursive: Initializes and updates all nested submodules
status: Shows the status of submodules
deinit <path>: Unregisters a submodule
sync: Syncs submodule URLs from .gitmodules to .git/config

Example

git submodule add https://github.com/lib/utils.git libs/utils
git submodule init
git submodule update --init --recursive