https://github.com/jroimartin/gocui
Minimalist Go package aimed at creating Console User Interfaces.
https://github.com/jroimartin/gocui
cui go gocui gui
Last synced: about 1 month ago
JSON representation
Minimalist Go package aimed at creating Console User Interfaces.
- Host: GitHub
- URL: https://github.com/jroimartin/gocui
- Owner: jroimartin
- License: bsd-3-clause
- Created: 2014-01-04T02:50:20.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-01T12:16:55.000Z (about 2 months ago)
- Last Synced: 2025-05-08T20:54:40.154Z (about 1 month ago)
- Topics: cui, go, gocui, gui
- Language: Go
- Homepage:
- Size: 252 KB
- Stars: 10,214
- Watchers: 130
- Forks: 621
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-go - gocui - Minimalist Go library aimed at creating Console User Interfaces. (Command Line / Advanced Console UIs)
- stars - jroimartin/gocui
- fucking-awesome-go - gocui - Minimalist Go library aimed at creating Console User Interfaces. (Command Line / Advanced Console UIs)
- my-awesome-starred - jroimartin/gocui - Minimalist Go package aimed at creating Console User Interfaces. (Go)
- awesome-github-repos - jroimartin/gocui - Minimalist Go package aimed at creating Console User Interfaces. (Go)
- awesome-go - gocui - Minimalist Go library aimed at creating Console User Interfaces. (Command Line / Advanced Console UIs)
- awesome-luooooob - jroimartin/gocui - Minimalist Go package aimed at creating Console User Interfaces. (Go)
- awesome-robotic-tooling - gocui - Minimalist Go package aimed at creating Console User Interfaces. (Interaction / Command Line)
- awesome-robotic-tooling - gocui - Minimalist Go package aimed at creating Console User Interfaces. (User Interaction / Command Line Interface)
- awesome-golang-repositories - gocui
- awesome-go - gocui - Minimalist Go library aimed at creating Console User Interfaces. (Command Line / Advanced Console UIs)
- awesome-go-extra - gocui - 01-04T02:50:20Z|2022-07-29T06:37:58Z| (Build Automation / Advanced Console UIs)
- awesome-go-with-stars - gocui - Minimalist Go library aimed at creating Console User Interfaces. (Command Line / Advanced Console UIs)
- StarryDivineSky - jroimartin/gocui
- awesome-go-cn - gocui
- awesome-go-plus - gocui - Minimalist Go library aimed at creating Console User Interfaces.  (Command Line / Advanced Console UIs)
- my-awesome - jroimartin/gocui - 05 star:10.3k fork:0.6k Minimalist Go package aimed at creating Console User Interfaces. (Go)
- awesome-go-plus - gocui - Minimalist Go library aimed at creating Console User Interfaces.  (Command Line / Advanced Console UIs)
- awesome-go - gocui - Minimalist Go library aimed at creating Console User Interfaces. Stars:`10.2K`. (Command Line / Advanced Console UIs)
- awesome-go - gocui - Minimalist Go package aimed at creating Console User Interfaces. - ★ 3643 (Command Line)
README
# GOCUI - Go Console User Interface
[](https://pkg.go.dev/github.com/jroimartin/gocui)
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:
```sh
go get github.com/jroimartin/gocui
```
## Documentation
Execute:
```sh
go doc github.com/jroimartin/gocui
```
Or visit [pkg.go.dev](https://pkg.go.dev/github.com/jroimartin/gocui) to read
it online.
## Example
```go
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
