gocui - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #golang #machine-learning #deep-learning #linux #awesome #vue #pytorch #security #ios #mcp #open-source

gocui

(★ 10,595)

Minimalist Go package aimed at creating Console User Interfaces.

File Explorer

Download Latest Version (.zip)

- active.go
- bufs.go
- colors.go
- colors256.go
- demo.go
- dynamic.go
- flow_layout.go
- goroutine.go
- hello.go
- layout.go
- Mark.Twain-Tom.Sawyer.txt
- mask.go
- mouse.go
- ontop.go
- overlap.go
- size.go
- stdin.go
- title.go
- widgets.go
- wrap.go
.gitignore
attribute.go
AUTHORS
doc.go
edit.go
escape.go
go.mod
go.sum
gui.go
keybinding.go
LICENSE
README.md
view.go

# Installation Guide

1. Get the code

git clone https://github.com/jroimartin/gocui

Downloads the entire project code from GitHub to your computer.

cd gocui

Moves into the project folder you just downloaded.

2. Go

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GOCUI - Go Console User Interface

[![Go Reference](https://pkg.go.dev/badge/github.com/jroimartin/gocui.svg)](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

![r2cui](https://cloud.githubusercontent.com/assets/1223476/19418932/63645052-93ce-11e6-867c-da5e97e37237.png)

![_examples/demo.go](https://cloud.githubusercontent.com/assets/1223476/5992750/720b84f0-aa36-11e4-88ec-296fa3247b52.png)

![_examples/dynamic.go](https://cloud.githubusercontent.com/assets/1223476/5992751/76ad5cc2-aa36-11e4-8204-6a90269db827.png)