base

Documentation

Overview

Package base defines shared basic pieces of the Lava command, in particular logging and the Command structure.

Index

• Variables
• type Command
  • func (c *Command) Name() string
  • func (c *Command) Usage()

Variables

var Commands []*Command

Commands is initialized with all the Lava commands.

var LogLevel = &slog.LevelVar{}

LogLevel is the level of the default logger.

Types

type Command

type Command struct {
	Run       func(args []string) error
	UsageLine string
	Short     string
	Long      string
	Flag      flag.FlagSet
}

Command represents a Lava command.

func (*Command) Name

func (c *Command) Name() string

Name returns the name of the command, which is the text before the first white space character in the UsageLine field.

func (*Command) Usage

func (c *Command) Usage()

Usage prints a usage message documenting the command.