Interface CheckoutOptions

CheckoutOptions defines the supported options for the Git checkout command.

Hierarchy

  • CheckoutOptions

Properties

--detach?: null

Checks out a commit for inspection and discardable experiments.

--force?: null

Proceeds if the index or the working tree differs from HEAD, even if there are untracked files when switching branches.

--ignore-skip-worktree-bits?: null

Ignores the sparse patterns and adds back any files in relativePaths.

--merge?: null

Performs a three-way merge between the current branch, your working tree contents, and the new branch.

--no-progress?: null

Suppresses progress reports to the standard error stream. See also --progress.

--no-track?: null

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

--orphan?: string | string[]

Creates a new orphan branch named and start it at . The value may be specified as a string or the first element of a string[]. The optional is the second element of a string[] when provided.

--ours?: null

Checks out stage #2 for unmerged paths when checking out paths from the index. See also --thiers.

--progress?: null

Forces progress reports to the standard error stream. See also --no-progress.

--quiet?: null

Suppresses feedback messages.

--thiers?: null

Checks out stage #3 for unmerged paths when checking out paths from the index. See also --ours.

--track?: null | string

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

-b?: string | string[]

Creates a new branch named and start it at . The value may be specified as a string or the first element of a string[]. The optional is the second element of a string[] when provided.

-l?: null

Creates the branch’s reflog.