jesseduffield.lazygit/pkg/gocui
Stefan Haller b4fb49acce Render async content into an off-screen buffer and swap it in
A cmd/pty re-render used to overwrite the displayed buffer from the top
down as lines arrived, relying on keeping the previous render's view-line
tail to avoid a blank frame. That left the view showing a mixture of old
and new content while loading, and any reader (draw, the diff-line
mapping, clicks) could observe a half-written buffer at the wrong scroll —
the §11 Race A flicker and the §8 stale-tail mapping both came from this.

Instead, build the new content in a second, off-screen viewBuffer: until
the task has read enough to paint, writes go there and the displayed
buffer — and so everything every reader sees — is left untouched. Once the
task reaches its first-paint point (InitialRefreshAfter, or EOF for short
content) it swaps the off-screen buffer in atomically and applies the
saved scroll in the same step, so the view jumps straight from the
previous render to the new one with no intermediate frame. Subsequent
lines append to the now-displayed buffer.

Swapping at the first-paint point means the displayed buffer is only a
viewport tall when it appears and then grows as the rest streams in toward
the count needed for an accurate scrollbar. The scrollbar is sized from the
displayed buffer's height, so left to itself the thumb would shrink and
snap back during that growth (most visibly: the files panel's periodic
refresh making the thumb jump while scrolled down). The total height the
scrollbar needs is a strictly later quantity than the viewport-fill paint,
so no single early swap can have both right. FreezeScrollbarHeight therefore
records the view's height when a load begins and the scrollbar is held there
— growing only if the new content turns out taller — until the load ends; a
synchronous render superseding the load releases it. This mirrors the layout
clamp, which already ignores the partial content height while a view loads.

With the swap doing a wholesale replace, refreshViewLinesIfNeeded can
truncate the view lines to the current buffer: there is no longer a
half-loaded shorter buffer whose tail we must keep showing, so the stale
tail (§8) never forms. clear()/Reset() abandon any in-progress off-screen
render so a synchronous SetContent after a stopped task writes to the
display.

This replaces the holdViewLines and freshViewLineCount patches reverted in
the previous two commits with one mechanism. The swap holds writeMutex for
now; it could later move to the main thread. Flicker behaviour still needs
interactive verification (LAZYGIT_SLOW_RENDER + a real pager).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-08-08 12:58:59 +02:00
..
attribute.go Bump tcell dependency to v3 2026-04-30 22:14:26 +02:00
AUTHORS Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
block_events_test.go Add gocui primitives to block input during an operation 2026-07-17 12:32:32 +02:00
CHANGES_tcell.md Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
CODE_OF_CONDUCT.md Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
CONTRIBUTING.md Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
doc.go Remove dead Modifier field from keybindings 2026-05-06 09:51:23 +02:00
double_click_test.go Add test for double-click detection 2026-07-31 08:22:35 +02:00
edit.go Convert keybinding fields to Keybinding 2026-05-25 15:32:47 +02:00
escape.go gocui: parse OSC 456 per-line diff metadata and attach it per cell 2026-08-08 12:58:59 +02:00
escape_test.go Materialize cursor-forward escapes as space runs 2026-07-03 18:47:15 +02:00
flush_test.go Make the user-event queue unbounded 2026-07-15 10:14:05 +02:00
gui.go Render async content into an off-screen buffer and swap it in 2026-08-08 12:58:59 +02:00
gui_others.go Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
gui_windows.go Fix linter warnings 2026-04-30 14:29:08 +02:00
key.go Move modifiers into Key 2026-04-30 22:22:53 +02:00
keybinding.go Remove dead Modifier field from keybindings 2026-05-06 09:51:23 +02:00
LICENSE Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
mouse_capture_test.go Route mouse events to their originating view during a drag gesture 2026-07-31 08:22:35 +02:00
README.md Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
scrollbar.go Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
scrollbar_test.go Copy gocui files into lazygit repo under pkg/gocui 2026-04-30 14:29:08 +02:00
suspend_test.go Schedule a redraw when resuming from suspension 2026-07-20 14:23:09 +02:00
task.go Exclude view-buffer render tasks from the busy query 2026-07-07 18:09:33 +02:00
task_manager.go Fix a deadlock between task.Done() and the integration test's idle wait 2026-07-15 15:01:04 +02:00
task_manager_test.go Fix a deadlock between task.Done() and the integration test's idle wait 2026-07-15 15:01:04 +02:00
tcell_driver.go Deliver mouse release after a drag 2026-07-31 08:22:35 +02:00
tcell_driver_test.go Deliver mouse release after a drag 2026-07-31 08:22:35 +02:00
text_area.go Exclude more commit trailers from auto-wrapping 2026-08-02 19:22:34 +02:00
text_area_test.go Exclude more commit trailers from auto-wrapping 2026-08-02 19:22:34 +02:00
user_event_queue_test.go Log the user-event queue's high-water mark 2026-07-15 10:14:05 +02:00
view.go Render async content into an off-screen buffer and swap it in 2026-08-08 12:58:59 +02:00
view_test.go Render async content into an off-screen buffer and swap it in 2026-08-08 12:58:59 +02:00

GOCUI - Go Console User Interface

CircleCI CodeCov Go Report Card GolangCI GoDoc GitHub tag (latest SemVer)

Minimalist Go package aimed at creating Console User Interfaces. A community fork based on the amazing work of jroimartin

Features

  • Minimalist API.
  • Views (the "windows" in the GUI) implement the interface io.ReadWriter.
  • Support for overlapping views.
  • The GUI can be modified at runtime (concurrent-safe).
  • Global and view-level keybindings.
  • Mouse support.
  • Colored text.
  • Customizable editing mode.
  • Easy to build reusable widgets, complex layouts...

About fork

This fork has many improvements over the original work from jroimartin.

  • Written ontop of TCell
  • Better wide character support
  • Support for 1 Line height views
  • Better support for running in docker container
  • Customize frame colors
  • Improved code comments and quality
  • Many small improvements
  • Change Visibility of views

For information about this org see: awesome-gocui/about.

Installation

Execute:

$ go get github.com/awesome-gocui/gocui

Documentation

Execute:

$ go doc github.com/awesome-gocui/gocui

Or visit godoc.org to read it online.

Example

See the _example folder for more examples

package main

import (
	"fmt"
	"log"

	"github.com/awesome-gocui/gocui"
)

func main() {
	g, err := gocui.NewGui(gocui.OutputNormal, true)
	if err != nil {
		log.Panicln(err)
	}
	defer g.Close()

	g.SetManagerFunc(layout)

	if err := g.SetKeybinding("", gocui.KeyCtrlC, gocui.ModNone, quit); err != nil {
		log.Panicln(err)
	}

	if err := g.MainLoop(); err != nil && !gocui.IsQuit(err) {
		log.Panicln(err)
	}
}

func layout(g *gocui.Gui) error {
	maxX, maxY := g.Size()
	if v, err := g.SetView("hello", maxX/2-7, maxY/2, maxX/2+7, maxY/2+2, 0); err != nil {
		if !gocui.IsUnknownView(err) {
			return err
		}

		if _, err := g.SetCurrentView("hello"); err != nil {
			return err
		}

		fmt.Fprintln(v, "Hello world!")
	}

	return nil
}

func quit(g *gocui.Gui, v *gocui.View) error {
	return gocui.ErrQuit
}

Screenshots

r2cui

_examples/demo.go

_examples/dynamic.go

Projects using gocui

  • komanda-cli: IRC Client For Developers.
  • vuls: Agentless vulnerability scanner for Linux/FreeBSD.
  • wuzz: Interactive cli tool for HTTP inspection.
  • httplab: Interactive web server.
  • domainr: Tool that checks the availability of domains based on keywords.
  • gotime: Time tracker for projects and tasks.
  • claws: Interactive command line client for testing websockets.
  • terminews: Terminal based RSS reader.
  • diagram: Tool to convert ascii arts into hand drawn diagrams.
  • pody: CLI app to manage Pods in a Kubernetes cluster.
  • kubexp: Kubernetes client.
  • kcli: Tool for inspecting kafka topics/partitions/messages.
  • fac: git merge conflict resolver
  • jsonui: Interactive JSON explorer for your terminal.
  • cointop: Interactive terminal based UI application for tracking cryptocurrencies.
  • lazygit: simple terminal UI for git commands.
  • lazydocker: The lazier way to manage everything docker.

Note: if your project is not listed here, let us know! :)