TOG(1)

TOG(1) — Git repository browser 🦋✨

NAME 💖

tog — Git repository browser 👑

SYNOPSIS 🌸

tog [-hV] command [arg ...]

tog path

DESCRIPTION ✨

okay so bestie, tog is literally an interactive read-only browser for Git repositories. No cap. The repository format is described in git-repository(5). 💅

tog supports several types of views which display repository data:

• Log view — Displays commits in the repository's history. This view is displayed initially if no command is specified, or if just a path is specified. 👑 main character energy fr fr.
• Diff view — Displays work tree changes or changes made in a particular commit. It's giving "what changed tho".
• Blame view — Displays the line-by-line history of a file. 🌸
• Tree view — Displays the tree corresponding to a particular commit. 🌳
• Ref view — Displays references in the repository. All the refs, slay.

tog provides global and command-specific key bindings and options. Some command-specific key bindings may be prefixed with an integer, which is denoted by N in the descriptions below, and is used as a modifier to the operation as indicated. tog will echo digits to the screen when count modifiers are entered, and complete the sequence upon input of the first non-numeric character. Count modifiers can be aborted by entering an unmapped key. Once a compound command is executed, the operation can be cancelled with C-g or Backspace. 😭 lowkey lifesaver.

Global options 💜

Global options must precede the command name, and are as follows:

• -h — Display usage information. 🙈
• -V, --version — Display program version and exit immediately. periodt.

Global key bindings 🎀

The global key bindings are:

• H, F1 — Display run-time help. Key bindings for the focussed view will be displayed. Pressing this again inside the help view will toggle the display of key bindings for all tog views. ✨
• Q — Quit tog. Bye bestie.
• q — Quit the view which is in focus. Just this view.
• Tab — Switch focus between views. Tab tab tab.
• F — Toggle fullscreen mode for a split-screen view. tog will automatically use vertical split-screen views if the size of the terminal window is sufficiently large. Big screen energy.
• S — Switch the current split-screen layout, and render all active views in this new layout. The split-screen layout can be either vertical or horizontal. If the terminal is not wide enough when switching to a vertical split, views will render in fullscreen. 💀
• - — When in a split-screen view, decrease the size of the focussed split N increments (default: 1). Shrink.
• + — When in a split-screen view, increase the size of the focussed split N increments (default: 1). Grow.
• G — Go to line N in the view (default: last line). Last line, we love to see it.
• g — Go to line N in the view (default: first line). First line, iconic.
• Right-arrow, l — Scroll view to the right N increments (default: 1). Output moves left on the screen. 👉
• Left-arrow, h — Scroll view to the left N increments (default: 1). Output moves right on the screen. 👈
• $ — Scroll view to the rightmost position. All the way right.
• 0 — Scroll view left to the start of the line. Back to the start.

Commands 👑

The commands for tog are as follows:

log 📜

log [-b] [-c commit] [-r repository-path] [path]

Display history of a repository. If a path is specified, show only commits which modified this path. If invoked in a work tree, the path is interpreted relative to the current working directory, and the work tree's path prefix is implicitly prepended. Otherwise, the path is interpreted relative to the repository root. fr fr.

If invoked in a work tree, the log entry of the work tree's base commit will be prefixed with one of the following annotations:

• * — work tree's base commit and the base commit of all tracked files matches the branch tip
• ~ — work tree comprises mixed commits or its base commit is out-of-date

This command is also executed if no explicit command is specified.

The key bindings for tog log are as follows (N denotes optional prefixed count modifier):

• Down-arrow, j, >, Full stop, Ctrl-n — Move the selection cursor down N lines (default: 1). Down down down.
• Up-arrow, k, <, Comma, Ctrl-p — Move the selection cursor up N lines (default: 1). Up up up.
• Page-down, Space, Ctrl+f, f — Move the selection cursor down N pages (default: 1). Zoom.
• Page-up, Ctrl+b, b — Move the selection cursor up N pages (default: 1). Zoom but up.
• Ctrl+d, d — Move the selection cursor down N half pages (default: 1). Half page, cute.
• Ctrl+u, u — Move the selection cursor up N half pages (default: 1). Half page up.
• Home, = — Move the cursor to the newest commit. Fresh.
• End, * — Move the cursor to the oldest commit. This will traverse all commits on the current branch which may take a long time depending on the number of commits in branch history. If needed, this operation can be cancelled with C-g or Backspace. ⏳
• g — Move the cursor to commit N (default: 1). Go to commit.
• G — Like g but defaults to the oldest commit. Oldest commit, no cap.
• Enter — Open a diff view showing file changes made in the currently selected commit. If a commit is marked with the m key map, open a diff view showing file changes made between the marked commit and the currently selected commit. Enter the diff.
• m — Mark or unmark the selected commit. When a commit is marked, pressing the enter key on another selected commit opens a diff view showing the changes between the marked commit and the currently selected commit. Mark it.
• T — Open a tree view showing the tree for the currently selected commit. Tree time.
• Backspace — Show log entries for the parent directory of the currently selected path. However when an active search is in progress or when additional commits are loaded, Backspace aborts the running operation. Back it up.
• / — Prompt for a search pattern and start searching for matching commits. The search pattern is an extended regular expression which is matched against a commit's author name, committer name, log message, and commit ID. Regular expression syntax is documented in re_format(7). Search slay.
• & — Prompt for a pattern and limit the log view's list of commits to those which match the pattern. If no pattern is specified, i.e. the & prompt is immediately closed with the Enter key, then the pattern is cleared. Until the pattern is cleared, the limited list of commits replaces the full list of commits for all operations supported by the log view. For example, a search started with / will search the limited list of commits, rather than searching all commits. The pattern is an extended regular expression which is matched against a commit's author name, committer name, log message, and commit ID. Regular expression syntax is documented in re_format(7). Filter vibes.
• n — Find the Nth next commit which matches the current search pattern (default: 1). Searching continues until either a match is found or C-g or the Backspace key is pressed. Next match.
• N — Find the Nth previous commit which matches the current search pattern (default: 1). Searching continues until either a match is found or C-g or the Backspace key is pressed. Previous match.
• Ctrl+l — Reload the log view with new commits found in the repository or new work tree changes. Refresh.
• B — Reload the log view and toggle display of merged commits. The -b option determines whether merged commits are displayed initially. Merge toggle.
• R — Open a ref view listing all references in the repository. This can then be used to open a new log view for arbitrary branches and tags. Refs on refs.
• @ — Toggle between showing the committer name and the author name. Who dis? Author or committer.

The options for tog log are as follows:

• -b — Display individual commits which were merged into the current branch from other branches. By default, tog log shows the linear history of the current branch only. The B key binding can be used to toggle display of merged commits at run-time. Merged commits, periodt.
• -c commit — Start traversing history at the specified commit. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords :base and :head resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with :+ or :- modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, :head:-2 denotes the work tree branch head's 2nd generation ancestor, and :base:+4 denotes the 4th generation descendant of the work tree's base commit. Similarly, foobar:+3 will denote the 3rd generation descendant of the commit resolved by the "foobar" reference. A :+ or :- modifier without a trailing integer has an implicit "1" appended (e.g., :base:+ is equivalent to :base:+1). So many modifiers, but iconic.
• -r repository-path — Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got(1) work tree, use the repository path associated with this work tree. Repo path, got it.

✨ COMMANDS ✨

okay bestie, this is the part where we get into the actual commands you can run with tog. It's giving main character energy for real. 💅

💖 diff 💖

diff [-asw] [-C number] [-c commit] [-r repository-path] [object1 object2 | path ...]

Okay so if you just run this inside a work tree with zero arguments, it shows you all the local changes in the work tree. ✨ If you pass one or more path arguments, it only shows changes inside those paths. No cap.

But wait, there's more. If you give it two object arguments, it shows the differences between those two objects in the repository. Treat each of the two arguments as a reference, a tag name, an object ID, or a keyword, and it'll show differences between the corresponding objects. Both objects must be the same type (blobs, trees, or commits). An abbreviated hash argument gets expanded to a full commit ID automatically, as long as the abbreviation is unique. 💯

The keywords :base and :head resolve to the work tree's base commit and branch head, respectively. The former is only valid if you're in a work tree, while the latter resolves to the tip of the work tree's current branch if you're in a work tree, otherwise it resolves to the repository's HEAD reference. 🎀

Keywords and references can be appended with :+ or :- modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively. For example, :head:-2 denotes the work tree branch head's 2nd generation ancestor, and :base:+4 denotes the 4th generation descendant of the work tree's base commit. Similarly, foobar:+3 will denote the 3rd generation descendant of the commit resolved by the "foobar" reference. A :+ or :- modifier without a trailing integer has an implicit 1 appended (e.g., :base:+ is equivalent to :base:+1). 🦋

The key bindings for tog diff are as follows (N denotes optional prefixed count modifier):

• a — Toggle treatment of file contents as ASCII text even if binary data was detected.
• Down-arrow, j, Ctrl-n — Scroll down N lines (default: 1).
• Up-arrow, k, Ctrl-p — Scroll up N lines (default: 1).
• Page-down, Space, Ctrl+f, f — Scroll down N pages (default: 1).
• Page-up, Ctrl+b, b — Scroll up N pages (default: 1).
• Ctrl+d, d — Scroll down N half pages (default: 1).
• Ctrl+u, u — Scroll up N half pages (default: 1).
• Home — Scroll to the top of the view.
• End — Scroll to the bottom of the view.
• g — Scroll to line N (default: 1).
• G — Like g but defaults to the last line in the diff.
• ( — Navigate to the Nth previous file in the diff (default: 1).
• ) — Navigate to the Nth next file in the diff (default: 1).
• { — Navigate to the Nth previous hunk in the diff (default: 1).
• } — Navigate to the Nth next hunk in the diff (default: 1).
• [ — Reduce diff context by N lines (default: 1).
• ] — Increase diff context by N lines (default: 1).
• <, Comma, K — If the diff view was opened via the log view, move to the Nth previous (younger) commit. If the diff was opened via the blame view, move to the Nth previous line and load the corresponding commit (default: 1).
• >, Full stop, J — If the diff view was opened via the log view, move to the Nth next (older) commit. If the diff was opened via the blame view, move to the Nth next line and load the corresponding commit (default: 1).
• p — Write the currently viewed diff to a patch file in /tmp. The patch pathname is drawn to the status line.
• / — Prompt for a search pattern and start searching for matching lines. The search pattern is an extended regular expression. Regular expression syntax is documented in re_format(7).
• n — Find the Nth next line which matches the current search pattern (default: 1).
• N — Find the Nth previous line which matches the current search pattern (default: 1).
• w — Toggle display of whitespace-only changes.
• A — Change the diff algorithm. Supported diff algorithms are Myers (quick and dirty) and Patience (slow and tidy). This is a global setting which also affects the blame view.

The options for tog diff are as follows:

• -a — Treat file contents as ASCII text even if binary data is detected.
• -C number — Set the number of context lines shown in the diff. By default, 3 lines of context are shown.
• -c commit — Show differences between commits in the repository. This option may be used up to two times. When used only once, show differences between the specified commit and its first parent commit. When used twice, show differences between the two specified commits.

The expected argument is a commit ID hash, or an existing reference, tag name, or keyword, which is resolved to a commit ID. Unique abbreviated hash arguments are automatically expanded to a full hash. Both objects must be of the same type (i.e., blobs, trees, or commits).

If the -c option is used, all non-option arguments are interpreted as paths. If one or more such path arguments are provided, only show differences for the specified paths.

• -r repository-path — Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got(1) work tree, use the repository path associated with this work tree.
• -s — Show changes staged with got stage instead of showing local changes in the work tree. This option is only valid when tog diff is invoked in a work tree with no -c options.
• -w — Ignore whitespace-only changes.

💜 blame 💜

blame [-c commit] [-r repository-path] path

Display line-by-line history of a file at the specified path. It's literally the detective work of who wrote what. 🕵️‍♀️

The key bindings for tog blame are as follows (N denotes optional prefixed count modifier):

• Down-arrow, j, Ctrl-n — Move the selection cursor down N pages (default: 1).
• Up-arrow, k, Ctrl-p — Move the selection cursor up N pages (default: 1).
• Page-down, Space, Ctrl+f, f — Move the selection cursor down N pages (default: 1).
• Page-up, Ctrl+b, b — Move the selection cursor up N pages (default: 1).
• Ctrl+d, d — Move the selection cursor down N half pages (default: 1).
• Ctrl+u, u — Move the selection cursor up N half pages (default: 1).
• Home — Move the selection cursor to the first line of the file.
• End — Move the selection cursor to the last line of the file.
• g — Move the selection cursor to line N (default: 1).
• G — Like g but defaults to the last line in the file.
• Enter — Open a diff view for the currently selected line's commit.
• c — Reload the blame view with the version of the file as found in the currently selected line's commit.
• p — Reload the blame view with the version of the file as found in the parent commit of the currently selected line's commit.
• C — Reload the blame view with the previously blamed commit.
• L — Open a log view for the currently selected annotated line.
• / — Prompt for a search pattern and start searching for matching lines. The search pattern is an extended regular expression. Regular expression syntax is documented in re_format(7).
• n — Find the Nth next line which matches the current search pattern (default: 1).
• N — Find the Nth previous line which matches the current search pattern (default: 1).
• A — Change the diff algorithm. Supported diff algorithms are Myers (quick and dirty) and Patience (slow and tidy). This is a global setting which also affects the diff view.

The options for tog blame are as follows:

• -c commit — Start traversing history at the specified commit. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords :base and :head resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with :+ or :- modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, :head:-2 denotes the work tree branch head's 2nd generation ancestor, and :base:+4 denotes the 4th generation descendant of the work tree's base commit. Similarly, foobar:+3 will denote the 3rd generation descendant of the commit resolved by the "foobar" reference. A :+ or :- modifier without a trailing integer has an implicit 1 appended (e.g., :base:+ is equivalent to :base:+1).
• -r repository-path — Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got(1) work tree, use the repository path associated with this work tree.

tree [-c commit] [-r repository-path] [path]

Okay bestie, this is the tree view 🌳 and it's literally giving you the whole repository tree. If you pass a path, it shows you the tree entries at that path. 💅

Displayed tree entries may carry one of the following trailing annotations, and you need to know them:

• @ — entry is a symbolic link 🔗
• / — entry is a directory 📁
• * — entry is an executable file ⚡
• $ — entry is a Git submodule 📦

Symbolic link entries are also annotated with the target path of the link. No cap. 🫶

The key bindings for tog tree are as follows (N denotes optional prefixed count modifier):

• Down-arrow, j, Ctrl-n — Move the selection cursor down N lines (default: 1). ⬇️
• Up-arrow, k, Ctrl-p — Move the selection cursor up N lines (default: 1). ⬆️
• Page-down, Space, Ctrl+f, f — Move the selection cursor down N pages (default: 1). 📄
• Page-up, Ctrl+b, b — Move the selection cursor up N pages (default: 1). 📄
• Ctrl+d, d — Move the selection cursor down N half pages (default: 1).
• Ctrl+u, u — Move the selection cursor up N half pages (default: 1).
• Home, = — Move the selection cursor to the first entry. 🏠
• End, * — Move the selection cursor to the last entry. 🏁
• g — Move the selection cursor to entry N (default: 1).
• G — Like g but defaults to the last entry.
• Enter — Enter the currently selected directory, or switch to the blame view for the currently selected file. 👀
• L — Open a log view for the currently selected tree entry. 📜
• R — Open a ref view listing all references in the repository. This can then be used to open a new tree view for arbitrary branches and tags. 🌿
• Backspace — Move back to the Nth parent directory (default: 1). ⬅️
• i — Show object IDs for all objects displayed in the tree view. 🆔
• / — Prompt for a search pattern and start searching for matching tree entries. The search pattern is an extended regular expression which is matched against the tree entry's name. Regular expression syntax is documented in re_format(7). 🔍
• n — Find the Nth next tree entry which matches the current search pattern (default: 1). ➡️
• N — Find the Nth previous tree entry which matches the current search pattern (default: 1). ⬅️

The options for tog tree are as follows:

• -c commit — Start traversing history at the specified commit. The expected argument is a commit ID, or a reference name or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full commit ID automatically, provided the abbreviation is unique. The keywords :base and :head resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. Keywords and references may be appended with :+ or :- modifiers and an optional integer N to denote the Nth descendant or antecedent by first parent traversal, respectively; for example, :head:-2 denotes the work tree branch head's 2nd generation ancestor, and :base:+4 denotes the 4th generation descendant of the work tree's base commit. Similarly, foobar:+3 will denote the 3rd generation descendant of the commit resolved by the "foobar" reference. A :+ or :- modifier without a trailing integer has an implicit "1" appended (e.g., :base:+ is equivalent to :base:+1). 🔥
• -r repository-path — Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got(1) work tree, use the repository path associated with this work tree. 📂

---

ref [-r repository-path]

Display references in the repository. ✨

The key bindings for tog ref are as follows (N denotes optional prefixed count modifier):

• Down-arrow, j, Ctrl-n — Move the selection cursor down N lines (default: 1). ⬇️
• Up-arrow, k, Ctrl-p — Move the selection cursor up N lines (default: 1). ⬆️
• Page-down, Space, Ctrl+f, f — Move the selection cursor down N pages (default: 1). 📄
• Page-up, Ctrl+b, b — Move the selection cursor up N pages (default: 1). 📄
• Ctrl+d, d — Move the selection cursor down N half pages (default: 1).
• Ctrl+u, u — Move the selection cursor up N half pages (default: 1).
• Home, = — Move the selection cursor to the first reference. 🏠
• End, * — Move the selection cursor to the last reference. 🏁
• g — Move the selection cursor to reference N (default: 1).
• G — Like g but defaults to the last reference.
• Enter — Open a log view which begins traversing history at the commit resolved via the currently selected reference. 📜
• T — Open a tree view showing the tree resolved via the currently selected reference. 🌳
• i — Show object IDs for all non-symbolic references displayed in the ref view. 🆔
• m — Show last modified date of each displayed reference. 📅
• o — Toggle display order of references between sort by name and sort by timestamp. 🔄
• / — Prompt for a search pattern and start searching for matching references. The search pattern is an extended regular expression which is matched against absolute reference names. Regular expression syntax is documented in re_format(7). 🔍
• n — Find the Nth next reference which matches the current search pattern (default: 1). ➡️
• N — Find the Nth previous reference which matches the current search pattern (default: 1). ⬅️
• Ctrl+l — Reload the list of references displayed by the ref view. 🔄

The options for tog ref are as follows:

• -r repository-path — Use the repository at the specified path. If not specified, assume the repository is located at or above the current working directory. If this directory is a got(1) work tree, use the repository path associated with this work tree. 📂

---

🌈 ENVIRONMENT 🌈

okay bestie listen up, this is the part where you make tog look exactly how you want it to look, and honestly? iconic behavior 💅

• TOG_COLORS — set this bad boy to literally any non-empty value and tog will show you colorized output. obsessed. and you can remix the whole default color scheme by setting the environment variables we're about to document below 👇 the colors you can use in color schemes are black, red, green, yellow, blue, magenta, cyan, and default — and that last one maps to your terminal's default foreground color, no cap 🎀

---

• TOG_COLOR_AUTHOR — the color used to mark up author information. if you don't set it, the default value cyan is used ✨
• TOG_COLOR_COMMIT — the color used to mark up commit IDs. if you don't set it, the default value green is used 💚
• TOG_COLOR_DATE — the color used to mark up date information. if you don't set it, the default value yellow is used 🌟
• TOG_COLOR_DIFF_CHUNK_HEADER — the color used to mark up chunk header lines in diffs. if you don't set it, the default value yellow is used 📜
• TOG_COLOR_DIFF_META — the color used to mark up meta data in diffs. if you don't set it, the default value green is used 🌿
• TOG_COLOR_DIFF_MINUS — the color used to mark up removed lines in diffs. if you don't set it, the default value magenta is used 💜
• TOG_COLOR_DIFF_PLUS — the color used to mark up added lines in diffs. if you don't set it, the default value cyan is used 🩵
• TOG_COLOR_REFS_BACKUP — the color used to mark up references in the refs/got/backup/ namespace. if you don't set it, the default value cyan is used 🎀
• TOG_COLOR_REFS_HEADS — the color used to mark up references in the refs/heads/ namespace. if you don't set it, the default value green is used 🌱
• TOG_COLOR_REFS_REMOTES — the color used to mark up references in the refs/remotes/ namespace. if you don't set it, the default value yellow is used ☀️
• TOG_COLOR_REFS_TAGS — the color used to mark up references in the refs/tags/ namespace. if you don't set it, the default value magenta is used 🏷️
• TOG_COLOR_TREE_DIRECTORY — the color used to mark up directory tree entries. if you don't set it, the default value cyan is used 📁
• TOG_COLOR_TREE_EXECUTABLE — the color used to mark up executable file tree entries. if you don't set it, the default value green is used ⚡
• TOG_COLOR_TREE_SUBMODULE — the color used to mark up submodule tree entries. if you don't set it, the default value magenta is used 🧩
• TOG_COLOR_TREE_SYMLINK — the color used to mark up symbolic link tree entries. if you don't set it, the default value magenta is used 🔗

---

• TOG_DIFF_ALGORITHM — this one decides the default diff algorithm that tog uses. the supported diff algorithms are Myers (quick and dirty) and Patience (slow and tidy). valid values for TOG_DIFF_ALGORITHM are patience and myers. if it's unset, the Patience diff algorithm will be used by default. so yeah, default vibe is slow and tidy, bestie 🦋
• TOG_VIEW_SPLIT_MODE — decides the default layout of your split-screen views. if you set it to h or H, tog will use horizontal split by default. otherwise, vertical split will be used. and the S key can be used to switch between vertical and horizontal split layout at run-time — live, mid-session, no restart needed 🔥

---

🚪 EXIT STATUS 🚪

the tog utility exits 0 on success, and >0 if an error occurs. so if it's zero we're thriving, if it's bigger than zero... something said no 😭

---

👀 SEE ALSO 👀

• got(1)
• git-repository(5)
• re_format(7)

go read those too, they're all part of the lore, iykyk 📚

---

👑 AUTHORS 👑

these are the legends who made tog happen, show some respect 💖

• Christian Weisgerber <naddy@openbsd.org>
• Josh Rickmar <jrick@zettaport.com>
• Joshua Stein <jcs@openbsd.org>
• Mark Jamsek <mark@jamsek.dev>
• Martin Pieuchot <mpi@openbsd.org>
• Omar Polo <op@openbsd.org>
• Stefan Sperling <stsp@openbsd.org>
• Klemens Nanni <kn@openbsd.org>

---

and that's the whole page, bestie 🎀 this one's the Debian build, riding with a $Mdocdate$ date stamp, filed under TOG(1). go read your history, stay colorful, and slay 💅✨🦋