/sunbeam

Generate complex TUIs from simple scripts written in any language.

Primary LanguageGoMIT LicenseMIT

Sunbeam

Demo

Warning: This is a work in progress. The API is not stable and may change at any time.

Roadmap

  • Finalize API V1, Write Documentation
  • An extension system inspired by Github Cli
  • Support for running the sunbeam host on a remote machine, and access it from the browser using xterm.js
  • Add a GUI using wails.io

Installation

go install github.com/sunbeamlauncher/sunbeam@latest

In order to install extension, either use the sunbeam extension browse command, or download one of the directory in the example folder and run sunbeam extension install .

Development

Libraries

Dependencies

  • Go >= 1.19

Running the TUI

SUNBEAM_LOG_FILE=$PWD/debug.log go run main.go`

The logs will be redirected to the debug.log file, use tail -f debug.log to follow them.