Interface BranchOptions

BranchOptions defines the supported options for the Git branch command.

Hierarchy

Properties

--abbrev? --all? --column? --contains? --copy? --create-reflog? --delete? --force? --format? --ignore-case? --list? --merged? --move? --no-abbrev? --no-column? --no-contains? --no-create-reflog? --no-merged? --no-track? --points-at? --quiet? --recurse-submodules? --remotes? --set-upstream-to? --show-current? --sort? --track? --unset-upstream? --verbose?

Properties

Optional --abbrev

--abbrev?: string | number

Show the shortest prefix that is at least hexdigits long that uniquely identifies the object. See also --no-abbrev.

Optional --all

--all?: null

Lists both remote-tracking branches and local branches.

Optional --column

--column?: null | string | string[]

Displays the tag listing in columns. See also --no-column.

Optional --contains

--contains?: null | string | string[]

Lists branches which contain the specified commit; HEAD if not specified. See also --no-contains.

Optional --copy

--copy?: null

Copies a branch.

Optional --create-reflog

--create-reflog?: null

Creates the branch’s reflog. See also --no-create-reflog.

Optional --delete

--delete?: null

Deletes an branch.

Optional --force

--force?: null

Replaces an existing branch with the given name, instead of failing.

Optional --format

--format?: string

Interpolates %(fieldname) from a branch ref being shown and the object it points at.

Optional --ignore-case

--ignore-case?: null

Makes sorting and filtering tags case insensitive.

Optional --list

--list?: null

Lists branches.

Optional --merged

--merged?: null | string | string[]

Lists branches whose commits are reachable from the specified commit; HEAD if not specified. See also --no-merged.

Optional --move

--move?: null

Moves/renames a branch.

Optional --no-abbrev

--no-abbrev?: null

Displays full sha1s in the output. See also --abbrev.

Optional --no-column

--no-column?: null

Does not display the tag listing in columns. See also --column.

Optional --no-contains

--no-contains?: null | string | string[]

Lists branches which don't contain the specified commit; HEAD if not specified. See also --contains.

Optional --no-create-reflog

--no-create-reflog?: null

Overrides an earlier --create-reflog. See also --create-reflog.

Optional --no-merged

--no-merged?: null | string | string[]

Lists refs whose commits are not reachable from the specified commit; HEAD if not specified. See also --merged.

Optional --no-track

--no-track?: null

Does not set up "upstream" configuration. See also --track.

Optional --points-at

--points-at?: null | string

Lists branches of the given object.

Optional --quiet

--quiet?: null

Suppresses non-error messages.

Optional --recurse-submodules

--recurse-submodules?: null

Causes the current command to recurse into submodules.

Optional --remotes

--remotes?: null

Lists or deletes (if used with --delete) the remote-tracking branches.

Optional --set-upstream-to

--set-upstream-to?: string

Sets "upstream" tracking configuration to the specified branch.

Optional --show-current

--show-current?: null

Prints the name of the current branch.

Optional --sort

--sort?: string | string[]

Sorts based on the given keys.

Optional --track

--track?: null | string

Sets "upstream" tracking configuration for the new branch. See also --no-track.

Optional --unset-upstream

--unset-upstream?: null

Removes "upstream" tracking configuration.

Optional --verbose

--verbose?: null | [null, null?]

Show the sha1 and commit subject line for each head in list mode. May be repeated to include the path of the linked worktree (if any) and the name of the upstream branch.

Settings

Member Visibility

Theme

On This Page