Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bettercallshao/kut

Documentation ¶

Index ¶

func Home() string
func Ingest(source string) error
func List() []string
func Path(name string) string
func Render(action Action) (string, error)
func Repo() string
type Action
type Menu
- func Load(name string) (Menu, error)
- func Parse(data []byte) (Menu, error)
type Param

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Home ¶

func Home() string

Home retrieves path of kut home e.g. /home/james/.kut

func Ingest ¶

func Ingest(source string) error

Ingest a file into system store

func List ¶

func List() []string

List generates available menus

func Path ¶

func Path(name string) string

Path generates the path to the named menu

func Render ¶

func Render(action Action) (string, error)

Render an action into a command

func Repo ¶

func Repo() string

Repo retrieves path of local repo e.g. /home/james/.kut/menus

Types ¶

type Action ¶

type Action struct {
	Name     string  `json:"name" binding:"required"`
	Help     string  `json:"help"`
	Template string  `json:"template" binding:"required"`
	Params   []Param `json:"params"`
}

Action struct: a thing a user can do

type Menu struct {
	Name    string   `json:"name" binding:"required"`
	Version string   `json:"version"`
	Help    string   `json:"help"`
	Actions []Action `json:"actions" binding:"required"`
	Hash    string   `json:"hash"`
}

Menu struct: a list of actions

func Load ¶

func Load(name string) (Menu, error)

Load a menu given a name

func Parse ¶ added in v0.4.6

func Parse(data []byte) (Menu, error)

Parse a menu given a blob

type Param ¶

type Param struct {
	Name  string `json:"name" binding:"required"`
	Help  string `json:"help"`
	Value string `json:"value"`
}

Param struct: a parameter for a action

Source Files ¶

View all Source files

menu.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL