nodecmd

Documentation

Overview

Package nodecmd contains the entrypoint for webmesh nodes.

Package nodecmd contains the entrypoint for webmesh nodes.

Index

• func Execute() error
• func GenBridgeMarkdownDoc(title string, weight int, outfile string) error
• func GenMarkdownDoc(title string, weight int, outfile string) error
• type Options
  • func NewOptions() *Options
  • func (o *Options) BindFlags(fs *flag.FlagSet) *Options
  • func (o *Options) Marshal() ([]byte, error)
  • func (o *Options) MarshalTo(w io.Writer) error
  • func (o *Options) Validate() error

Functions

func Execute

func Execute() error

func GenBridgeMarkdownDoc

func GenBridgeMarkdownDoc(title string, weight int, outfile string) error

GenBridgeMarkdownDoc generates the markdown documentation for the bridge commands.

func GenMarkdownDoc

func GenMarkdownDoc(title string, weight int, outfile string) error

GenMarkdownDoc generates markdown documentation for the node command

Types

type Options

type Options struct {
	Global *global.Options `yaml:"global,omitempty" json:"global,omitempty" toml:"global,omitempty"`

	Mesh     *mesh.Options       `yaml:",inline" json:",inline" toml:",inline"`
	Bridge   *meshbridge.Options `yaml:"bridge,omitempty" json:"bridge,omitempty" toml:"bridge,omitempty"`
	Services *services.Options   `yaml:"services,omitempty" json:"services,omitempty" toml:"services,omitempty"`
}

Options are the node options.

func NewOptions

func NewOptions() *Options

NewOptions creates new options.

func (*Options) BindFlags

func (o *Options) BindFlags(fs *flag.FlagSet) *Options

BindFlags binds the flags. The options are returned for convenience.

func (*Options) Marshal

func (o *Options) Marshal() ([]byte, error)

Marshal returns the marshaled options.

func (*Options) MarshalTo

func (o *Options) MarshalTo(w io.Writer) error

func (*Options) Validate

func (o *Options) Validate() error

Validate runs all the validation checks.