HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

git submodule — Inspect, update, and manage submodules. More information: <https://git-scm.com/docs/git-submodule>.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
commandupdateandclimanagesubmodulesinspectgit submodule

Problem

How to use the git submodule command: Inspect, update, and manage submodules. More information: <https://git-scm.com/docs/git-submodule>.

Solution

git submodule — Inspect, update, and manage submodules. More information: <https://git-scm.com/docs/git-submodule>.

View existing submodules and the checked-out commit for each one:
git submodule


Install a repository's submodules (listed in .gitmodules):
git submodule update --init --recursive


Add a Git repository as a submodule of the current one:
git submodule add {{repository_url}}


Add a Git repository as a submodule of the current one, at a specific directory:
git submodule add {{repository_url}} {{path/to/directory}}


Update submodules to their latest commits:
git submodule update --remote


Change the URL of a submodule:
git submodule set-url {{path/to/submodule}} {{new_url}}


Unregister a submodule (e.g. before removing it from the repository with git rm):
git submodule deinit {{path/to/submodule}}

Code Snippets

View existing submodules and the checked-out commit for each one

git submodule

Install a repository's submodules (listed in `.gitmodules`)

git submodule update --init --recursive

Add a Git repository as a submodule of the current one

git submodule add {{repository_url}}

Add a Git repository as a submodule of the current one, at a specific directory

git submodule add {{repository_url}} {{path/to/directory}}

Update submodules to their latest commits

git submodule update --remote

Context

tldr-pages: common/git submodule

Revisions (0)

No revisions yet.