GitHub Hot Board

GitHub Hot Board · Repository archive

jroimartin/gocui

Minimalist Go package aimed at creating Console User Interfaces. (This description comes from the repository itself.)

Data at October 25jroimartin

Best

#422

All-time · Go facet

11K

Total stars

642

Total forks

0

Days on boards (30d)

Project statusLicense: BSD-3-ClauseLast push: May 1Open issues: 61

Collected since 2026-10-25; unknown = not yet harvested

Put your badge on the README · jroimartin/gocui[![Put your badge on the README](https://git.vaiox.xyz/api/badge/jroimartin/gocui.svg)](https://git.vaiox.xyz/en/repo/jroimartin/gocui)
<a href="https://git.vaiox.xyz/en/repo/jroimartin/gocui"><img src="https://git.vaiox.xyz/api/badge/jroimartin/gocui.svg" alt="Put your badge on the README" height="20"></a>

README

GOCUI - Go Console User Interface

Go Reference

Minimalist Go package aimed at creating Console User Interfaces.

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 edition mode.
  • Easy to build reusable widgets, complex layouts...

Installation

Execute:

go get github.com/jroimartin/gocui

Documentation

Execute:

go doc github.com/jroimartin/gocui

Or visit pkg.go.dev to read it online.

Example

package main

import (
	"fmt"
	"log"

	"github.com/jroimartin/gocui"
)

func main() {
	g, err := gocui.NewGui(gocui.OutputNormal)
	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 && err != gocui.ErrQuit {
		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); err != nil {
		if err != gocui.ErrUnknownView {
			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

Current rankings

Momentum, past 30 days

No leaderboard records in the last 30 days.

Similar projects · shared topics

← Back to boards