GOCUI - Go Console User Interface

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

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! :)

jesseduffield / gocui