status

Documentation

Overview

Package status git-status - Show the working tree status

SYNOPSIS

Reference: https://git-scm.com/docs/git-status

git status [<options>...] [--] [<pathspec>...]

DESCRIPTION

Displays paths that have differences between the index file and the current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not tracked by Git (and are not ignored by gitignore(5)). The first are what you would commit by running git commit; the second and third are what you could commit by running git add before running git commit.

Index

• func AheadBehind(g *types.Cmd)
• func Branch(g *types.Cmd)
• func Column(options string) func(*types.Cmd)
• func FindRenames(n string) func(*types.Cmd)
• func IgnoreSubmodules(when string) func(*types.Cmd)
• func Ignored(mode string) func(*types.Cmd)
• func Long(g *types.Cmd)
• func NoAheadBehind(g *types.Cmd)
• func NoColumn(g *types.Cmd)
• func NoRenames(g *types.Cmd)
• func Null(g *types.Cmd)
• func PathSpec(paths ...string) func(*types.Cmd)
• func Porcelain(version string) func(*types.Cmd)
• func Renames(g *types.Cmd)
• func Short(g *types.Cmd)
• func ShowStash(g *types.Cmd)
• func UntrackedFiles(mode string) func(*types.Cmd)
• func Verbose(g *types.Cmd)

Functions

func AheadBehind

func AheadBehind(g *types.Cmd)

AheadBehind Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch. Defaults to true. --ahead-behind, --no-ahead-behind

func Branch

func Branch(g *types.Cmd)

Branch Show the branch and tracking info even in short-format. -b, --branch

func Column

func Column(options string) func(*types.Cmd)

Column Display untracked files in columns. See configuration variable column.status for option syntax. --column and --no-column without options are equivalent to always and never respectively. --column[=<options>], --no-column

func FindRenames

func FindRenames(n string) func(*types.Cmd)

FindRenames Turn on rename detection, optionally setting the similarity threshold. See also git-diff(1) --find-renames. -M, --find-renames[=<n>]

func IgnoreSubmodules

func IgnoreSubmodules(when string) func(*types.Cmd)

IgnoreSubmodules Ignore changes to submodules when looking for changes. <when> can be either "none", "untracked", "dirty" or "all", which is the default. Using "none" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the ignore option in git- config(1) or gitmodules(5). When "untracked" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content). Using "dirty" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior before 1.7.0). Using "all" hides all changes to submodules (and suppresses the output of submodule summaries when the config option status.submoduleSummary is set). --ignore-submodules[=<when>]

func Ignored

func Ignored(mode string) func(*types.Cmd)

Ignored Show ignored files as well.

The mode parameter is used to specify the handling of ignored files. It is optional: it defaults to traditional.

The possible options are:

• traditional - Shows ignored files and directories, unless --untracked-files=all is specified, in which case individual files in ignored directories are displayed. • no - Show no ignored files. • matching - Shows ignored files and directories matching an ignore pattern.

When matching mode is specified, paths that explicitly match an ignored pattern are shown. If a directory matches an ignore pattern, then it is shown, but not paths contained in the ignored directory. If a directory does not match an ignore pattern, but all contents are ignored, then the directory is not shown, but all contents are shown. --ignored[=<mode>]

func Long

func Long(g *types.Cmd)

Long Give the output in the long-format. This is the default. --long

func NoAheadBehind

func NoAheadBehind(g *types.Cmd)

NoAheadBehind Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch. Defaults to true. --ahead-behind, --no-ahead-behind

func NoColumn

func NoColumn(g *types.Cmd)

NoColumn Display untracked files in columns. See configuration variable column.status for option syntax. --column and --no-column without options are equivalent to always and never respectively. --column[=<options>], --no-column

func NoRenames

func NoRenames(g *types.Cmd)

NoRenames Turn on/off rename detection regardless of user configuration. See also git-diff(1) --no-renames. --renames, --no-renames

func Null

func Null(g *types.Cmd)

Null Terminate entries with NUL, instead of LF. This implies the --porcelain=v1 output format if no other format is given. -z, --null

func PathSpec

func PathSpec(paths ...string) func(*types.Cmd)

PathSpec <pathspec>... See the pathspec entry in gitglossary(7).

func Porcelain

func Porcelain(version string) func(*types.Cmd)

Porcelain Give the output in an easy-to-parse format for scripts. This is similar to the short output, but will remain stable across Git versions and regardless of user configuration. See below for details. The version parameter is used to specify the format version. This is optional and defaults to the original version v1 format. --porcelain[=<version>]

func Renames

func Renames(g *types.Cmd)

Renames Turn on/off rename detection regardless of user configuration. See also git-diff(1) --no-renames. --renames, --no-renames

func Short

func Short(g *types.Cmd)

Short Give the output in the short-format. -s, --short

func ShowStash

func ShowStash(g *types.Cmd)

ShowStash Show the number of entries currently stashed away. --show-stash

func UntrackedFiles

func UntrackedFiles(mode string) func(*types.Cmd)

UntrackedFiles Show untracked files.

The mode parameter is used to specify the handling of untracked files. It is optional: it defaults to all, and if specified, it must be stuck to the option (e.g. -uno, but not -u no).

The possible options are:

• no - Show no untracked files. • normal - Shows untracked files and directories. • all - Also shows individual files in untracked directories.

When -u option is not used, untracked files and directories are shown (i.e. the same as specifying normal), to help you avoid forgetting to add newly created files. Because it takes extra work to find untracked files in the filesystem, this mode may take some time in a large working tree. Consider enabling untracked cache and split index if supported (see git update-index --untracked-cache and git update-index --split-index), Otherwise you can use no to have git status return more quickly without showing untracked files.

The default can be changed using the status.showUntrackedFiles configuration variable documented in git-config(1). -u[<mode>], --untracked-files[=<mode>]

func Verbose

func Verbose(g *types.Cmd)

Verbose In addition to the names of files that have been changed, also show the textual changes that are staged to be committed (i.e., like the output of git diff --cached). If -v is specified twice, then also show the changes in the working tree that have not yet been staged (i.e., like the output of git diff). -v, --verbose