Skip to content
This repository has been archived by the owner on Oct 13, 2021. It is now read-only.

marcusolsson/tui-go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tui: Terminal UI for Go

Build Status GoDoc Go Report Card License MIT stability-experimental

A UI library for terminal applications.

tui (pronounced tooey) provides a higher-level programming model for building rich terminal applications. It lets you build layout-based user interfaces that (should) gracefully handle resizing for you.

Example

Status

This project is highly experimental and will change a lot. Use at your own risk.

Installation

go get github.com/marcusolsson/tui-go

Usage

import "github.com/marcusolsson/tui-go"

If you want to know what it is like to build terminal applications with tui-go, check out some of the examples.

Documentation

The documentation is rather bare at the moment due to me changing the API pretty frequently. You can however explore the API in its current form at godoc.org.

Contributing

Feel free to submit pull requests, but consider letting me know by posting an issue first to make sure that your contributions will outlive any major refactoring in the near future.

Please post any feature requests you might have. Smaller requests might end up being implemented rather quickly and larger ones will be considered for the road map.

Related projects

tui-go is mainly influenced by Qt and offers a similar programming model that has been adapted to Go and the terminal.

Following Go projects are related to tui-go but offers different approaches for creating terminal applications.

  • termbox-go is used by tui-go for drawing to the terminal.
  • gocui is a more minimalistic library for creating console user interfaces.
  • termui focuses on building terminal dashboards.

License

tui-go is released under the MIT License.