cli

Documentation

Index

• func New(docsFS embed.FS) *cobra.Command
• type BuildInfo
  • func (b BuildInfo) String() string
• type UnitSizer

Functions

func New

func New(docsFS embed.FS) *cobra.Command

New creates the root command for the astro CLI.

Types

type BuildInfo

type BuildInfo struct {
	Version   string
	Commit    string
	Date      string
	GoVersion string
	Platform  string
}

BuildInfo describes the running binary.

func (BuildInfo) String

func (b BuildInfo) String() string

String renders the build information on one line.

It carries no program name: cobra's --version template already prefixes one, and the version subcommand adds its own.

type UnitSizer

type UnitSizer func(data []byte) int

UnitSizer reports the length of the unit starting at the front of data, or a value below one when the data so far is too short to tell.

It mirrors the package-level sizers the protocol packages expose, such as spp.PacketSizer.