Skip to content
Míng hàn edited this page May 12, 2026 · 1 revision

🖥️ Usage Guide

This guide explains how to use git-tree after installation.


🚀 Opening a Repository

When you launch git-tree, you will see the home screen with three options:

📁 Local Repository

  • Select the Local Folder tab
  • Enter the path to your git repository
  • Or use the folder picker button
  • Click OPEN

Example:

~/projects/my-repo

🌐 Remote Repository (Clone)

  • Select the Remote URL tab
  • Paste a Git repository URL
  • Click CLONE

Example:

https://github.com/user/repository.git

The repository will be cloned automatically and opened.


🔍 Search GitHub

  • Select the Search Online tab
  • Enter a query (e.g. project name or keyword)
  • Click SEARCH
  • Choose a repository and click CLONE

🌳 Navigating the Git Tree

Once a repository is opened:

🖱️ Mouse Controls

  • Click a commit node → view details
  • Scroll (CTRL + wheel) → zoom in/out
  • Drag → pan around the tree

⌨️ Keyboard Controls

  • ← / → → move between commits (horizontal view)
  • ↑ / ↓ → move between commits (vertical view)
  • ESC → deselect commit

📄 Commit Details

Clicking a commit shows:

  • Author
  • Date
  • Commit message
  • Hash
  • Diff statistics

🔎 Diff Viewer

  • Open full diff view from toolbar
  • View file-by-file changes
  • Expand/collapse file sections
  • See added (+) and removed (-) lines

📊 Repository Stats

The stats panel shows:

  • Contributor leaderboard
  • Commit heatmap (last 52 weeks)
  • Activity overview

🎨 Themes & Settings

You can customize the UI:

  • 15 built-in themes
  • Font size control
  • Node spacing (Compact / Normal / Wide)
  • Merge commit visibility toggle
  • Tree direction (Horizontal / Vertical)
  • CRT scanline effect

🧭 Minimap

  • Bottom corner minimap shows full tree overview
  • Click anywhere to jump to that section

💡 Tip

For the best experience:

  • Use a wide screen
  • Enable vertical mode for large repositories
  • Use minimap for fast navigation

Clone this wiki locally