tree: 3860f77160ff8ff962d2e5579e5b0f98b87846ba [path history] [tgz]
  1. _demos/
  2. api.go
  3. api_common.go
  4. api_windows.go
  5. AUTHORS
  6. collect_terminfo.py
  7. LICENSE
  8. README.google
  9. README.md
  10. syscalls.go
  11. syscalls_darwin_386.go
  12. syscalls_darwin_amd64.go
  13. syscalls_freebsd.go
  14. syscalls_linux.go
  15. syscalls_netbsd.go
  16. syscalls_openbsd.go
  17. syscalls_windows.go
  18. termbox.go
  19. termbox_common.go
  20. termbox_windows.go
  21. terminfo.go
  22. terminfo_builtin.go
go/src/github.com/nsf/termbox-go/README.md

Termbox

Termbox is a library that provides a minimalistic API which allows the programmer to write text-based user interfaces. The library is crossplatform and has both terminal-based implementations on *nix operating systems and a winapi console based implementation for windows operating systems. The basic idea is an abstraction of the greatest common subset of features available on all major terminals and other terminal-like APIs in a minimalistic fashion. Small API means it is easy to implement, test, maintain and learn it, that's what makes the termbox a distinct library in its area.

Installation

Install and update this go package with go get -u github.com/nsf/termbox-go

Examples

For examples of what can be done take a look at demos in the _demos directory. You can try them with go run: go run _demos/keyboard.go

There are also some interesting projects using termbox-go:

  • godit is an emacsish lightweight text editor written using termbox.
  • gomatrix connects to The Matrix and displays it's data streams in your terminal.
  • httopd is top for httpd logs.
  • termui is a terminal dashboard.

API reference

godoc.org/github.com/nsf/termbox-go