git¶

Update the index not only where the working tree has a file matching but also where the index already has an entry. all=off emits --ignore-removal.

Override the executable bit of the added files.

Don't actually add the file(s), just show if they exist and/or will be ignored.

Open the diff vs. the index in an editor and let the user edit it.

Allow adding otherwise ignored files.

If some files could not be added because of errors indexing them, do not abort the operation, but continue adding the others.

This option can only be used together with --dry-run.

Record only the fact that the path will be added later.

Show the context between diff hunks, up to the specified of lines, thereby fusing hunks that are close to each other. Added in 2.51.0.

Add modified contents in the working tree interactively to the index.

By default, git add will warn when adding an embedded repository to the index without using git submodule add to create an entry in .gitmodules.

Interactively choose hunks of patch between the index and the work tree and add them to the index.

Only meaningful with --pathspec-from-file.

Pathspec is passed in instead of commandline args.

Don't add the file(s), but only refresh their stat() information in the index.

Apply the "clean" process freshly to all tracked files to forcibly add them again to the index.

Allow updating index entries outside of the sparse-checkout cone.

Generate diffs with lines of context. Added in 2.51.0.

Update the index just where it already has an entry matching .

Be verbose.

Shortcut for --copy --force.

Shortcut for --delete --force.

Shortcut for --move --force.

In the verbose listing that show the commit object name, show the shortest prefix that is at least hexdigits long that uniquely refers the object.

List both remote-tracking branches and local branches.

Color branches to highlight current, local, and remote-tracking branches. Value optional: True for the bare flag, or pass one.

Display branch listing in columns. Value optional: True for the bare flag, or pass one.

Only list branches which contain (HEAD if not specified).

Copy a branch, together with its config and reflog.

Create the branch's reflog.

Delete a branch.

Open an editor and edit the text to explain what the branch is for, to be used by various other commands (e.g.

Reset to , even if exists already.

A string that interpolates %(fieldname) from a branch ref being shown and the object it points at.

Sorting and filtering branches are case insensitive.

List branches.

Only list branches whose tips are reachable from (HEAD if not specified).

Move/rename a branch, together with its config and reflog.

Display the full sha1s in the output listing rather than abbreviating them.

Turn off branch colors, even when the configuration file gives the default to color output.

Only list branches which don't contain (HEAD if not specified).

Only list branches whose tips are not reachable from (HEAD if not specified).

Do not set up "upstream" configuration, even if the branch.autoSetupMerge configuration variable is set.

Do not print a newline after formatted refs where the format expands to the empty string.

Only list branches of

Be more quiet when creating or deleting a branch, suppressing non-error messages.

THIS OPTION IS EXPERIMENTAL! Cause the current command to recurse into submodules if submodule.propagateBranches is enabled.

List or delete (if used with -d) the remote-tracking branches.

As this option had confusing syntax, it is no longer supported.

Set up 's tracking information so is considered 's upstream branch.

Print the name of the current branch.

Sort based on .

When creating a new branch, set up branch..remote and branch..merge configuration entries to set "upstream" tracking configuration for the new branch. Value optional: True for the bare flag, or pass one.

Remove the upstream information for .

When in list mode, show sha1 and commit subject line for each head, along with relationship to upstream branch (if any).

The same as -b, except that if the branch already exists it resets to the start point instead of failing.

Create a new branch named , start it at , and check the resulting branch out; see git-branch(1) for details.

The same as --merge option above, but changes the way the conflicting hunks are presented, overriding the merge.conflictStyle configuration variable.

Rather than checking out a branch to work on it, check out a commit for inspection and discardable experiments.

When switching branches, proceed even if the index or the working tree differs from HEAD, and even if there are untracked files in the way.

If is not found but there does exist a tracking branch in exactly one remote (call it ) with a matching name, treat as equivalent to $ git checkout -b --track / If the branch exists in multiple remotes and one of them is named by the checkout.defaultRemote configuration variable, we'll use that one for the purposes of disambiguation, even if the isn't unique across all remotes. guess=off emits --no-guess.

git checkout refuses when the wanted branch is already checked out or otherwise in use by another worktree.

In sparse checkout mode, git checkout -- .

Show the context between diff hunks, up to the specified of lines, thereby fusing hunks that are close to each other. Added in 2.51.0.

Create the new branch's reflog; see git-branch(1) for details.

When switching branches, if you have local modifications to one or more files that are different between the current branch and the branch to which you are switching, the command refuses to switch branches in order to preserve your modifications in context.

Do not set up "upstream" configuration, even if the branch.autoSetupMerge configuration variable is true.

Create a new unborn branch, named , started from and switch to it.

When checking out paths from the index, check out stage #2 (ours) or #3 (theirs) for unmerged paths.

In the default overlay mode, git checkout never removes files from the index or the working tree.

Silently overwrite ignored files when switching branches.

Interactively select hunks in the difference between the (or the index, if unspecified) and the working tree.

Only meaningful with --pathspec-from-file.

Pathspec is passed in instead of commandline args.

Progress status is reported on the standard error stream by default when it is attached to a terminal, unless --quiet is specified.

Quiet, suppress feedback messages.

Using --recurse-submodules will update the content of all active submodules according to the commit recorded in the superproject.

When creating a new branch, set up "upstream" configuration. Value optional: True for the bare flag, or pass one.

Generate diffs with lines of context. Added in 2.51.0.

Also apply the partial clone filter to any submodules in the repository.

Make a bare Git repository.

Point the newly created HEAD to branch instead of the branch pointed to by the cloned repository's HEAD.

Before fetching from the remote, fetch a bundle from the given and unbundle the data into the local repository.

Set a configuration variable in the newly-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out.

Create a shallow clone with a history truncated to the specified number of commits.

Borrow the objects from reference repositories specified with the --reference options only to reduce network transfer, and stop borrowing from them after a clone is made by making necessary local copies of borrowed objects.

Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter.

The number of submodules fetched at the same time.

When the repository to clone from is on a local machine, this flag bypasses the normal "Git aware" transport mechanism and clones the repository by making a copy of HEAD and everything under objects and refs directories.

Set up a mirror of the source repository.

Do not checkout HEAD after the clone is complete.

Force the cloning process from a repository on a local filesystem to copy the files under the .git/objects directory instead of using hardlinks.

Fail if the source repository is a shallow repository. Added in 2.54.0.

Instead of using the remote name origin to keep track of the upstream repository, use .

Report progress status on the standard error stream by default when attached to a terminal, unless --quiet is specified.

Operate quietly.

After the clone is created, initialize and clone submodules within based on the provided . Value optional: True for the bare flag, or pass one.

Specify the given ref storage format for the repository.

If the reference is on the local machine, automatically setup .git/objects/info/alternates to obtain objects from the reference .

All submodules which are cloned will use the status of the submodule's remote-tracking branch to update the submodule, rather than the superproject's recorded SHA-1. Added in 2.52.0.

Create a new repository, and fetch the history leading to the given revision (and nothing else), without making any remote-tracking branch, and without making any local branch, and detach HEAD to .

Instead of placing the cloned repository where it is supposed to be, place the cloned repository at the specified directory, then make a filesystem-agnostic Git symbolic link to there.

Transmit the given string to the server when communicating using protocol version 2.

Create a shallow clone with a history, excluding commits reachable from a specified remote branch or tag. May be repeated: a list emits the flag once per item.

Create a shallow clone with a history after the specified time.

All submodules which are cloned will be shallow with a depth of 1. Added in 2.52.0.

When the repository to clone is on the local machine, instead of using hard links, automatically setup .git/objects/info/alternates to share the objects with the source repository.

Clone only the history leading to the tip of a single branch, either specified by the --branch option or the primary branch remote's HEAD points at. Added in 2.52.0.

Employ a sparse-checkout, with only files in the toplevel directory initially being present.

Control whether or not tags will be cloned. Added in 2.52.0.

Specify the directory from which templates will be used; (See the "TEMPLATE DIRECTORY" section of git-init(1).).

Specify a non-default path for the command run on the other end when the repository to clone from is accessed via ssh.

Run verbosely.

Automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.

Usually recording a commit that has the exact same tree as its sole parent commit is a mistake, and the command prevents you from making such a commit.

Create a commit with an empty commit message without using plumbing commands like git-commit-tree(1).

Replace the tip of the current branch by creating a new commit.

Override the commit author.

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

Determine how the supplied commit message should be cleaned up before committing.

Override the author date used in the commit.

Do not create a commit, but show a list of paths that are to be committed, paths with local changes that will be left uncommitted and paths that are untracked.

Let the user further edit the message taken from with -F , command line with -m , and from with -C . edit=off emits --no-edit.

Take the commit message from .

Create a new commit which "fixes up" when applied with git rebase --autosquash. May be repeated: a list emits the flag once per item.

GPG-sign commits. Value optional: True for the bare flag, or pass one.

Before making a commit out of staged contents so far, stage the contents of paths given on the command line as well.

Show the context between diff hunks, up to the specified of lines, thereby fusing hunks that are close to each other. Added in 2.51.0.

When doing a dry-run, give the output in the long-format.

Use as the commit message.

Bypass the post-rewrite hook.

When showing short or porcelain git-status(1) output, print the filename verbatim and terminate the entries with NUL, instead of LF.

Make a commit by taking the updated working tree contents of the paths specified on the command line, disregarding any contents that have been staged for other paths.

Use the interactive patch selection interface to choose which changes to commit.

Only meaningful with --pathspec-from-file.

Pass pathspec in instead of commandline args.

When doing a dry-run, give the output in a porcelain-ready format.

Suppress commit summary message.

Like -C, but with -c the editor is invoked, so that the user can further edit the commit message.

When used with -C/-c/--amend options, or when committing after a conflicting cherry-pick, declare that the authorship of the resulting commit now belongs to the committer.

Take an existing object, and reuse the log message and the authorship information (including the timestamp) when creating the commit.

When doing a dry-run, give the output in the short-format.

Add a Signed-off-by trailer by the committer at the end of the commit log message.

Construct a commit message for use with git rebase --autosquash. May be repeated: a list emits the flag once per item.

Include the output of git-status(1) in the commit message template when using an editor to prepare the commit message. status=off emits --no-status.

When editing the commit message, start the editor with the contents in . May be repeated: a list emits the flag once per item.

Specify a (, ) pair that should be applied as a trailer. May be repeated: a list emits the flag once per item.

Generate diffs with lines of context. Added in 2.51.0.

Show untracked files. Value optional: True for the bare flag, or pass one.

Show unified diff between the HEAD commit and what would be committed at the bottom of the commit message template to help the user describe the commit by reminding what changes the commit has.

Bypass the pre-commit and commit-msg hooks.

Instead of using the default number of hexadecimal digits (which will vary according to the number of objects in the repository with a default of 7) of the abbreviated object name, use digits, or as many digits as needed to form a unique object name.

Instead of using only the annotated tags, use any ref found in refs/ namespace.

Show uniquely abbreviated commit object as fallback.

Instead of considering only the 10 most recent tags as candidates to describe the input commit-ish consider up to candidates.

Instead of finding the tag that predates the commit, find the tag that comes after the commit, and thus contains it.

Verbosely display information about the searching strategy being employed to standard error.

Describe the state of the working tree. Value optional: True for the bare flag, or pass one.

Only output exact matches (a tag directly references the supplied commit).

Do not consider tags matching the given glob(7) pattern, excluding the "refs/tags/" prefix.

Follow only the first parent commit upon seeing a merge commit.

Always output the long format (the tag, the number of commits and the abbreviated commit name) even when it matches a tag.

Only consider tags matching the given glob(7) pattern, excluding the "refs/tags/" prefix.

Instead of using only the annotated tags, use any tag found in refs/tags namespace.

Look for differences whose patch text contains added/removed lines that match .

Control the order in which files appear in the output.

Swap two inputs; that is, show differences from index or on-disk file to tree contents.

Look for differences that change the number of occurrences of the specified (i.e.

Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show the shortest prefix that is at least hexdigits long that uniquely refers the object. Value optional: True for the bare flag, or pass one.

Generate a diff using the "anchored diff" algorithm. May be repeated: a list emits the flag once per item.

Compare the working tree with • the "base" version (stage #1) when using -1 or --base, • "our branch" (stage #2) when using -2 or --ours, or • "their branch" (stage #3) when using -3 or --theirs.

In addition to --full-index, output a binary diff that can be applied with git-apply.

Break complete rewrite changes into pairs of delete and create. Value optional: True for the bare flag, or pass one.

Warn if changes introduce conflict markers or whitespace errors.

Show colored diff. Value optional: True for the bare flag, or pass one.

Moved lines of code are colored differently. Value optional: True for the bare flag, or pass one.

This configures how whitespace is ignored when performing the move detection for --color-moved. May be repeated: a list emits the flag once per item.

Equivalent to --word-diff=color plus (if a regex was specified) --word-diff-regex=. Value optional: True for the bare flag, or pass one.

Output a condensed summary of extended header information such as file creations or deletions ("new" or "gone", optionally +l if it's a symlink) and mode changes (+x or -x for adding or removing executable bit respectively) in diffstat.

Synonym for --dirstat=cumulative.

Use the default source and destination prefixes ("a/" and "b/").

Choose a diff algorithm.

Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (i.e. May be repeated: a list emits the flag once per item.

Output the distribution of relative amount of changes for each sub-directory. Value optional: True for the bare flag, or pass one.

Synonym for --dirstat=files,,. Value optional: True for the bare flag, or pass one.

Show the given destination instead of "b/".

Make the program exit with codes similar to diff(1).

Allow an external diff helper to be executed. ext_diff=off emits --no-ext-diff.

Detect copies as well as renames. Value optional: True for the bare flag, or pass one.

For performance reasons, by default, -C option finds copies only if the original file of the copy was modified in the same changeset.

Look for differences that change the number of occurrences of the specified object.

Detect renames. Value optional: True for the bare flag, or pass one.

Instead of the first handful of characters, show the full pre- and post-image blob object names on the "index" line when generating patch format output.

Show whole function as context lines for each change.

Generate a diff using the "histogram diff" algorithm.

Ignore whitespace when comparing lines.

Ignore changes whose lines are all blank.

Ignore carriage-return at the end of line when doing a comparison.

Ignore changes whose all lines match . May be repeated: a list emits the flag once per item.

Ignore changes in whitespace at EOL.

Ignore changes in amount of whitespace.

Ignore changes to submodules in the diff generation. Value optional: True for the bare flag, or pass one.

Enable the heuristic that shifts diff hunk boundaries to make patches easier to read. indent_heuristic=off emits --no-indent-heuristic.

Show the context between diff hunks, up to the specified of lines, thereby fusing hunks that are close to each other.

Omit the preimage for deletes, i.e. print only the header but not the diff between the preimage and /dev/null.

By default entries added by git add -N appear as an existing empty file in git diff and a new file in git diff --cached.

The -M and -C options involve some preliminary steps that can detect subsets of renames/copies cheaply, followed by an exhaustive fallback portion that compares all remaining unpaired destinations to all relevant sources.

Prepend an additional to every line of output.

For each pathspec given on command line, descend at most levels of directories. Added in 2.52.0.

Spend extra time to make sure the smallest possible diff is produced.

Show only the name of each changed file in the post-image tree.

Show only the name(s) and status of each changed file.

Turn off colored diff.

Turn off move detection.

Do not ignore whitespace when performing move detection.

Do not show any source or destination prefix.

Turn off rename detection, even when the configuration file gives the default to do so.

Similar to --stat, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly.

Output to a specific file instead of stdout.

Specify the character used to indicate new, old or context lines in the generated patch.

Generate patch (see the section called "GENERATING PATCH TEXT WITH -P"). patch=off emits --no-patch.

Synonym for -p --raw.

Synonym for -p --stat.

Generate a diff using the "patience diff" algorithm.

When -S or -G finds a change, show all the changes in that changeset, not just the files that contain the change in .

Treat the given to -S as an extended POSIX regular expression to match.

Disable all output of the program.

Generate the diff in raw format.

When run from a subdirectory of the project, it can be told to exclude changes outside the directory and show pathnames relative to it with this option. Value optional: True for the bare flag, or pass one.

Whether to use empty blobs as rename source. Added in 2.52.0.

Output only the last line of the --stat format containing total number of modified files, as well as number of added and deleted lines.

Discard the files before the named from the output (i.e.

Show the given source instead of "a/".

Generate a diffstat. Value optional: True for the bare flag, or pass one.

Specify how differences in submodules are shown. Value optional: True for the bare flag, or pass one.

Output a condensed summary of extended header information such as creations, renames and mode changes.

Treat all files as text.

Allow (or disallow) external text conversion filters to be run when comparing binary files.

Generate diffs with lines of context.

By default, words are delimited by whitespace; see --word-diff-regex below. Value optional: True for the bare flag, or pass one.

Use to decide what a word is, instead of considering runs of non-whitespace to be a word.

Highlight whitespace errors in the context, old or new lines of the diff.

When --raw, --numstat, --name-only or --name-status has been given, do not munge pathnames and use NULs as output field terminators.

Fetch all remotes, except for the ones that have the remote..skipFetchAll configuration variable set. Added in 2.52.0.

Append ref names and object names of fetched refs to the existing contents of .git/FETCH_HEAD.

Use an atomic transaction to update local refs.

Run git maintenance run --auto at the end to perform automatic repository maintenance if needed. Added in 2.52.0.

Similar to --depth, except it specifies the number of commits from the current shallow boundary instead of from the tip of each remote branch history.

Limit fetching to the specified number of commits from the tip of each remote branch history.

Show what would be done, without making any changes.

Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. Added in 2.54.0.

When git fetch is used with : refspec, it may refuse to update the local branch as discussed in the part below.

Use IPv4 addresses only, ignoring IPv6 addresses.

Use IPv6 addresses only, ignoring IPv4 addresses.

Parallelize all forms of fetching up to jobs at a time.

Keep downloaded pack.

Allow several and arguments to be specified.

Do not fetch anything from the server, and instead print the ancestors of the provided --negotiation-restrict= arguments, which we have in common with the server.

Ensure that the commits at the given tips are always sent as "have" lines during fetch negotiation, regardless of what the negotiation algorithm selects. Added in 2.55.0.

By default, Git will report, to the server, commits reachable from all local refs to find common commits in an attempt to reduce the size of the to-be-received packfile. Added in 2.55.0.

By default, Git will report, to the server, commits reachable from all local refs to find common commits in an attempt to reduce the size of the to-be-received packfile. Gone since 2.55.0.

Disable recursive fetching of submodules (this has the same effect as using the --recurse-submodules=no option).

Print the output to standard output in an easy-to-parse format for scripts.

Modify the configured refspec to place all refs into the refs/prefetch/ namespace.

Progress status is reported on the standard error stream by default when it is attached to a terminal, unless -q is specified.

Before fetching, remove any remote-tracking references that no longer exist on the remote.

Before fetching, remove any local tags that no longer exist on the remote if --prune is enabled.

Pass --quiet to git-fetch-pack and silence any other internally used git commands.

Control if and under what conditions new commits of submodules should be fetched too. Value optional: True for the bare flag, or pass one.

This option is used internally to temporarily provide a non-negative default value for the --recurse-submodules option.

Instead of negotiating with the server to avoid transferring commits and associated objects that are already present locally, this option fetches all objects as a fresh clone would.

When fetching refs listed on the command line, use the specified refspec (can be given more than once) to map the refs to remote-tracking branches, instead of the values of remote..fetch configuration variables for the remote repository. May be repeated: a list emits the flag once per item.

Transmit the given string to the server when communicating using protocol version 2.

If the remote is fetched successfully, add upstream (tracking) reference, used by argument-less git-pull(1) and other commands.

Deepen or shorten the history of a shallow repository to exclude commits reachable from a specified remote branch or tag. May be repeated: a list emits the flag once per item.

Deepen or shorten the history of a shallow repository to include all reachable commits after .

By default, git checks if a branch is force-updated during fetch. show_forced_updates=off emits --no-show-forced-updates.

Read refspecs, one per line, from stdin in addition to those provided as arguments.

Prepend to paths printed in informative messages such as "Fetching submodule foo".

Fetch all tags from the remote (i.e., fetch remote tags refs/tags/* into local tags with the same name), in addition to whatever else would otherwise be fetched. tags=off emits --no-tags.

If the source repository is complete, convert a shallow repository to a complete one, removing all the limitations imposed by shallow repositories.

By default git fetch refuses to update the head which corresponds to the current branch.

By default when fetching from a shallow repository, git fetch refuses refs that require updating .git/shallow.

When given, and the repository to fetch from is handled by git fetch-pack, --exec= is passed to the command to specify non-default path for the command run on the other end.

Be verbose.

Write a commit-graph after fetching. Added in 2.52.0.

Write the list of remote refs fetched in the FETCH_HEAD file directly under $GIT_DIR. Added in 2.52.0.

Create a bare repository.

Use for the initial branch in the newly created repository.

Specify the given object (hash algorithm) for the repository.

Only print error and warning messages; all other output will be suppressed.

Specify the given ref storage for the repository.

Instead of initializing the repository as a directory to either $GIT_DIR or ./.git/, create a text file there containing the path to the actual repository.

Specify that the Git repository is to be shared amongst several users. Value optional: True for the bare flag, or pass one.

Specify the directory from which templates will be used.