Variables¶

The following variables can be set:

diff-options (string)

blame-options (string)

log-options (string)

main-options (string)

reference-format (string)

line-graphics (mixed) [ascii|default|utf-8|auto|<bool>]

truncation-delimiter (mixed) [utf-8|<string>]

horizontal-scroll (mixed)

git-colors (list)

show-notes (mixed) [<reference>|<bool>]

show-changes (bool)

show-untracked (bool)

vertical-split (mixed) [auto|<bool>]

split-view-height (mixed)

split-view-width (mixed)

status-show-untracked-dirs (bool)

status-show-untracked-files (bool)

tab-size (int)

diff-context (int)

word-diff (bool)

diff-highlight (mixed)

ignore-space (mixed) [no|all|some|at-eol|<bool>]

commit-order (enum) [auto|default|topo|date|author-date|reverse]

ignore-case (enum) [no|yes|smart-case]

mailmap (bool)

wrap-lines (bool)

wrap-search (bool)

focus-child (bool)

send-child-enter (bool)

editor-line-number (bool)

history-size (int)

mouse (bool)

mouse-scroll (int)

mouse-wheel-cursor (bool)

pager-autoscroll (bool)

pgrp (bool)

start-on-head (bool)

refresh-mode (mixed) [manual|auto|after-command|periodic|<bool>]

refresh-interval (int)

file-args (args)

rev-args (args)

View settings¶

The view settings define the order and options for the different columns of a view. Each view setting expects a space-separated list of column specifications. Column specifications starts with the column type, and can optionally be followed by a colon (:) and a list of column options. E.g. the following column specification defines an author column displaying the author email and with a fixed width of 20 characters: author:email,width=20.

The first option value in a column specification is always the display option. When no display value is given, yes is assumed. For display options expecting an enumerated value this will automatically resolve to the default enum value. For example, file-name will automatically have its display setting resolve to auto.

Specifications can also be given for a single column, for example to override the defaults in the system tigrc file. To override a single column, use the column name as a suffix after the view setting name, e.g. main-view-date will allow to set the date in the main view.

Examples:

# Enable both ID and line numbers in the blame view
set blame-view = date:default author:full file-name:auto id:yes,color \


                 line-number:yes,interval=5 text
# Change grep view to be similar to `git grep` format
set grep-view = file-name:yes line-number:yes,interval=1 text
# Show file sizes as units
set tree-view = line-number:no,interval=5 mode author:full \


                file-size:units date:default id:no file-name
# Show line numbers for every 10th line in the pager view
set pager-view = line-number:yes,interval=10 text
# Shorthands to change view settings for a previously defined column
set main-view-date = custom
set main-view-date-format = "%Y-%m-%d %H:%M"
set blame-view-line-number = no
# Use Git's default commit order, even when the commit graph is enabled.
set commit-order = default

The following list shows which the available view settings and what column types they support:

blob-view, diff-view, log-view, pager-view, stage-view

blame-view

grep-view

main-view, reflog-view

refs-view

stash-view

status-view

tree-view

Supported column types and their respective column options:

author

commit-title

date

file-name

file-size

id

line-number

mode

ref

status

text

All column options can be toggled. For display options, use the option name as the prefix followed by a dash and the column name. E.g. :toggle author-display will toggle the display option in the author column. For all other options use the column name followed by a dash and then the option name as the suffix. E.g. :toggle commit-title-graph will toggle the graph option in the commit-title column. Alternatively, use the option menu to manipulate options.

External user-defined command¶

These actions start with one or more of the following option flags followed by the command that should be executed.

Unless otherwise specified, commands are run in the foreground with their console output shown (as if ! was specified). When multiple command options are specified their behavior are combined, e.g. "?<git commit" will prompt the user whether to execute the command and will exit Tig after completion.

Note that if you want to use pipes or redirection in your commands then you must run them in a subshell, i.e. embed your commands in sh -c '<commands>'.

Browsing state variables

# Save the current commit as a patch file when the user selects a commit
# in the main view and presses 'S'.
bind main S !git format-patch -1 %(commit)
# Create and checkout a new branch; specify custom prompt
bind main B ?git checkout -b "%(prompt Enter new branch name: )"
# Show commit statistics for the author under the cursor
bind main U +sh -c 'git --no-pager shortlog -s --author="$(git show -s --format=%aE %(commit))" </dev/tty'

Advanced shell-like commands

bind generic I @sh -c "echo -n %(commit) | xclip -selection c"

[alias]


        gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"


        publish = !"for i in origin public; do git push $i; done"
[tig "bind"]


        generic = V @git gitk-bg


        generic = > !git publish

Internal user-defined commands¶

Actions beginning with a : will be run and interpreted as internal commands and act similar to commands run via Tig’s prompt. Valid internal commands are configuration file options (as described in this document) and pager view commands. Examples:

# Reload ~/.tigrc when 'S' is pressed
bind generic S :source .tigrc
# Change diff view to show all commit changes regardless of file limitations
bind diff F :set diff-options = --full-diff
# Show the output of git-reflog(1) in the pager view
bind generic W :!git reflog
# Search for previous diff (c)hunk and next diff header
bind stage 2 :?^@@
bind stage D :/^diff --(git|cc)
bind main I :toggle id                          # Show/hide the ID column
bind diff D :toggle diff-options --minimal      # Use minimal diff algorithm
bind diff [ :toggle diff-context -3             # Decrease context (-U arg)
bind diff ] :toggle diff-context +3             # Increase context
bind generic V :toggle split-view-height -10%   # Decrease split height

Similar to external commands, pager view commands can contain variable names that will be substituted before the command is run.

Action names¶

Valid action names are described below. Note, all action names are case-insensitive, and you may use -, _, and . interchangeably, e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.

View switching

View manipulation

View-specific actions

Cursor navigation

Scrolling

Searching

Misc

UI colors¶

The colors and attributes to be used for the text that is not highlighted or that specify the use of the default terminal colors can be controlled by setting the default color option.

Table 1. General

Table 2. Main view colors

Table 3. Status view

Table 4. Help view

Highlighting¶

Diff markup

diff-header, diff-chunk, diff-stat, diff-add, diff-add2, diff-del, diff-del2, diff-add-highlight, diff-del-highlight

Enhanced Git diff markup

diff-oldmode, diff-newmode, diff-copy-from, diff-copy-to, diff-similarity, diff-index

Pretty print commit headers

pp-refs, pp-reflog, pp-reflogmsg, pp-merge

Raw commit header

commit, parent, tree, author, committer

Commit message

Tree markup

tree-dir, tree-file