Skip to content
Zgit

Getting Started

Welcome to Zgit — the Git client that combines a desktop app, a terminal TUI, and AI-assisted workflows.

Quick Install

Section titled “Quick Install”
Terminal window
curl -fsSL https://zgit.pages.dev/install | bash

Or use your package manager:

Platform Command
Arch Linux (AUR) yay -S zgit-desktop-bin
Arch Linux (CLI) yay -S zgit-bin
macOS (Homebrew) brew install zaidejjo/tap/zgit
Windows (Scoop) scoop bucket add zgit https://github.com/zaidejjo/scoop-zgit && scoop install zgit
Any (Go) go install github.com/zaidejjo/zgit/cmd/zgit@latest

Launch

Section titled “Launch”
Terminal window
zgit desktop    # Launch the desktop app
zgit            # Launch the terminal TUI

First Launch

Section titled “First Launch”

When you run Zgit for the first time:

  1. Config is created at ~/.config/zgit/config.yaml
  2. The dashboard shows your current repo status
  3. If no repo is open, use File > Open Repository or Ctrl+O

Desktop App

Section titled “Desktop App”

The desktop app (React + TypeScript + Wails v2) features:

  • Real-time Git status with file watcher (fsnotify)
  • Inline diff viewer with syntax highlighting
  • AI commit message generation
  • PR creation and management
  • GitHub OAuth integration
  • Custom themes with accent sliders
  • Resizable panels and merge conflict editor

Terminal TUI

Section titled “Terminal TUI”

The TUI (Bubble Tea) is for terminal-first workflows:

Terminal window
zgit
Key Action
s Stage/unstage
S Stage all
c Commit
p Push
b Branch switcher
l Log view
d Diff view
? Help

Next Steps

Section titled “Next Steps”