greasi

README

greasi

Package greasi extends Grease by generating GUIs; it is the Grease graphical user Interface (Greasi)

Documentation

Index

• Constants
• func App[T any](opts *grease.Options, cfg T, cmds ...*grease.Cmd[T])
• func GUI[T any](opts *grease.Options, cfg T, cmds ...*grease.Cmd[T])
• func Run[T any, C grease.CmdOrFunc[T]](opts *grease.Options, cfg T, cmds ...C) error

Constants

const (
	// Version is the version of this package being used
	Version = "v0.8.22"
	// GitCommit is the commit just before the latest version commit
	GitCommit = "97943d2"
	// VersionDate is the date-time of the latest version commit in UTC (in the format 'YYYY-MM-DD HH:MM', which is the Go format '2006-01-02 15:04')
	VersionDate = "2023-12-26 23:39"
)

Functions

func App

func App[T any](opts *grease.Options, cfg T, cmds ...*grease.Cmd[T])

App does runs the GUI. It should be called on the main thread. It should typically not be called by end-user code; see Run.

func GUI

func GUI[T any](opts *grease.Options, cfg T, cmds ...*grease.Cmd[T])

func Run

func Run[T any, C grease.CmdOrFunc[T]](opts *grease.Options, cfg T, cmds ...C) error

Run runs the given app with the given default configuration file paths. It is similar to grease.Run, but it also runs the GUI if no arguments were provided. The app should be a pointer, and configuration options should be defined as fields on the app type. Also, commands should be defined as methods on the app type with the suffix "Cmd"; for example, for a command named "build", there should be the method:

func (a *App) BuildCmd() error

Run uses os.Args for its arguments.