goes

README

When imported by a machine main, package goes provides a monolithic embedded distro for Linux systems,

How is this pronounced?

We prefer "go e-s", aka. "go e[mbedded]-s[ystem]".

How is it monlithic?

The Live CD of most Linux distributions is an assembly of binary packages and base configuration. It may also include a guided self installer that copies its contents to the target along with other network acquired packages. These binary packages are built from interdependent source packages by a maintainer.

With goes, the package assembly, base configuration, and interdependency is handled by go build. The result is a single, thus monolithic, program including all of the commands that the maintainer intends to support on the target machine. This may include a guided self installer that, generally, doesn't require network install of anything else.

Alternatively, goes may run as a self-spawning daemons and interactive sub- commands within a minimal Linux distribution.

What are machines?

Machines are main packages that provide a goes command manifest, configuration, and customization before calling Goes.Main(). See https://github.com/platinasystems/goes-MACHINE for examples.

These machines are available at https://github.com/platinasystems/,

• goes-example (GOARCH: amd64 or armhf)
• goes-boot (GOARCH: amd64)
• goes-platina-mk1 (GOARCH: amd64)
• goes-bmc (GOARCH: armhf)

Most machines are built with just go build but some, like the bmc, may also use goes-build to build a properly configured kernel and embed itself as an initrd.

To install,

$ sudo ./goes-MACHINE install
...

To stop and remove,

$ sudo goes uninstall

To enable BASH completion after install,

. /usr/share/bash-completion/completions/goes

To run commands without install,

$ ./goes-MACHINE COMMAND [ARGS]...
...

To see the commands available on the installed MACHINE,

$ goes help

Or,

$ goes
goes> help

Then man any of the listed commands or man cli to see how to use the command line interface.

To debug,

$ gdb ./goes-MACHINE

Each goes/cmd provides apropos, completion, man, and usage. The command may also provide context sensitive help, README, and godoc.

• goes apropos COMMAND
• goes complete COMMAND [ARGS]...
• goes man COMMAND
• goes usage COMMAND
• goes help COMMAND [ARGS]...
• https://github.com/platinasystems/goes/blob/master/cmd/COMMAND/README.md
• https://godoc.org/github.com/platinasystems/goes/cmd/COMMAND

See also errata.

---

© 2015-2019 Platina Systems, Inc. All rights reserved. Use of this source code is governed by this BSD-style LICENSE.

Documentation

Overview

Package goes, combined with a compatibly configured Linux kernel, provides a monolithic embedded system.

Index

• Constants
• Variables
• func Replace(s, name string) string
• func Usage(v Usager) string
• type Blocker
• type Function
• type Goes
  • func (g *Goes) Apropos() lang.Alt
  • func (g *Goes) Builtins() map[string]func(...string) error
  • func (g *Goes) Complete(args ...string) (completions []string)
  • func (g *Goes) Fork(args ...string) *exec.Cmd
  • func (g *Goes) Goes(parent *Goes)
  • func (g *Goes) Help(args ...string) string
  • func (g *Goes) Main(args ...string) error
  • func (g *Goes) MakeListFunc(pipeline []piperun) (func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error, error)
  • func (g *Goes) MakePipefun(pipeline []func(io.Reader, io.Writer, io.Writer) error, closers *[]io.Closer) (func(io.Reader, io.Writer, io.Writer) error, error)
  • func (g *Goes) Man() lang.Alt
  • func (g *Goes) Names() []string
  • func (g *Goes) Path() []string
  • func (g *Goes) ProcessCommand(cl shellutils.Cmdline, closers *[]io.Closer) (func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error, error)
  • func (g *Goes) ProcessList(ls shellutils.List) (*shellutils.List, *shellutils.Word, ...)
  • func (g *Goes) ProcessPipeline(ls shellutils.List) (*shellutils.List, *shellutils.Word, ...)
  • func (g *Goes) String() string
  • func (g *Goes) Usage() string
• type Usager

Constants

const (
	VerboseQuiet = iota
	VerboseVerify
	VerboseDebug
)

Variables

var (
	Stop chan struct{}
	WG   sync.WaitGroup
)

All goes go-routines should add them selves to the WG WaitGroup and quit on Stop like this,

goes.WG.Add(1)
go func() {
	defer goes.WG.Done()
	for {
		select {
		case <-goes.Stop:
			return
		default:
			...
		}
	}
}

Functions

func Replace

func Replace(s, name string) string

func Usage

func Usage(v Usager) string

Types

type Blocker

type Blocker interface {
	Block(*Goes, shellutils.List) (*shellutils.List,
		func(io.Reader, io.Writer, io.Writer) error,
		error)
}

type Function

type Function struct {
	Name       string
	Definition []string
	RunFun     func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error
}

type Goes

type Goes struct {
	// These uppercased fields may/should be assigned at instantiation
	NAME, USAGE  string
	APROPOS, MAN lang.Alt

	ByName map[string]cmd.Cmd

	Catline io.ReadWriter

	Status    error
	Verbosity int

	EnvMap map[string]string

	FunctionMap map[string]Function
	// contains filtered or unexported fields
}

func (*Goes) Apropos

func (g *Goes) Apropos() lang.Alt

func (*Goes) Builtins

func (g *Goes) Builtins() map[string]func(...string) error

func (*Goes) Complete

func (g *Goes) Complete(args ...string) (completions []string)

func (*Goes) Fork

func (g *Goes) Fork(args ...string) *exec.Cmd

Fork returns an exec.Cmd ready to Run or Output this program with the given args.

func (*Goes) Goes

func (g *Goes) Goes(parent *Goes)

func (*Goes) Help

func (g *Goes) Help(args ...string) string

func (*Goes) Main

func (g *Goes) Main(args ...string) error

Run a command in the current context.

If len(args) == 1 and args[0] doesn't match a mapped command, this will run the "cli".

If the args has "-help", or "--help", this runs ByName("help").Main(args...) to print text.

Similarly for "-apropos", "-complete", "-man", and "-usage".

If the command is a daemon, this fork exec's itself twice to disassociate the daemon from the tty and initiating process.

func (*Goes) MakeListFunc

func (g *Goes) MakeListFunc(pipeline []piperun) (func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error, error)

func (*Goes) MakePipefun

func (g *Goes) MakePipefun(pipeline []func(io.Reader, io.Writer, io.Writer) error, closers *[]io.Closer) (func(io.Reader, io.Writer, io.Writer) error, error)

func (*Goes) Man

func (g *Goes) Man() lang.Alt

func (*Goes) Names

func (g *Goes) Names() []string

func (*Goes) Path

func (g *Goes) Path() []string

set Path of sub-goes. e.g. "ip address"

func (*Goes) ProcessCommand

func (g *Goes) ProcessCommand(cl shellutils.Cmdline, closers *[]io.Closer) (func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error, error)

func (*Goes) ProcessList

func (g *Goes) ProcessList(ls shellutils.List) (*shellutils.List, *shellutils.Word, func(stdin io.Reader, stdout io.Writer, stderr io.Writer) error, error)

func (*Goes) ProcessPipeline

func (g *Goes) ProcessPipeline(ls shellutils.List) (*shellutils.List, *shellutils.Word, func(io.Reader, io.Writer, io.Writer) error, error)

func (*Goes) String

func (g *Goes) String() string

func (*Goes) Usage

func (g *Goes) Usage() string

type Usager

type Usager interface {
	Usage() string
}