Interface SubmoduleOptions

SubmoduleOptions defines the supported options for the Git submodule command.

Hierarchy

  • SubmoduleOptions

Properties

--all? --branch? --cached? --checkout? --default? --depth? --dissociate? --files? --filter? --force? --init? --jobs? --merge? --name? --no-fetch? --no-recommend-shallow? --no-single-branch? --progress? --quiet? --rebase? --recommend-shallow? --recursive? --reference? --remote? --single-branch? --summary-limit?

Properties

Optional --all

--all?: null

Unregisters all submodules in the working tree.

Optional --branch

--branch?: string

Specifies the branch.

Optional --cached

--cached?: null

Uses the commit in the index instead of HEAD.

Optional --checkout

--checkout?: null

Overrides submodule.$name.update.

Optional --default

--default?: null

Causes the tracking branch to default to the remote HEAD.

Optional --depth

--depth?: string | number

Creates a shallow clone with history truncated to the specified number of revisions.

Optional --dissociate

--dissociate?: null

Modifies the behavior of --reference.

Optional --files

--files?: null

Compares the commit in the index to HEAD.

Optional --filter

--filter?: string

Specifies the filter.

Optional --force

--force?: null

Overrides command-specific behavior.

Optional --init

--init?: null

Initializes submodules.

Optional --jobs

--jobs?: string | number

Limits parallel submodule cloning.

Optional --merge

--merge?: null

Merges the commit in the superproject into the submodule.

Optional --name

--name?: string

Sets the submodule name.

Optional --no-fetch

--no-fetch?: null

Does not fetch new objects from the remote.

Optional --no-recommend-shallow

--no-recommend-shallow?: null

Overrides submodule.name.shallow. See also --recommend-shallow.

Optional --no-single-branch

--no-single-branch?: null

Does not create only one branch. See also --single-branch.

Optional --progress

--progress?: null

Reports progress on the standard error stream.

Optional --quiet

--quiet?: null

Prints error messages only.

Optional --rebase

--rebase?: null

Rebases the current branch onto the commit in the superproject.

Optional --recommend-shallow

--recommend-shallow?: null

Overrides submodule.name.shallow. See also --no-recommend-shallow.

Optional --recursive

--recursive?: null

Traverses submodules recursively.

Optional --reference

--reference?: string

Specifies the repository to clone.

Optional --remote

--remote?: null

Uses the status of the submodule's remote tracking branch.

Optional --single-branch

--single-branch?: null

Creates only one branch. See also --no-single-branch.

Optional --summary-limit

--summary-limit?: string | number

Limits the summary size.

Settings

Member Visibility

Theme

On This Page