cmd

Documentation

Overview

Package cmd is the base package for various sets of builds and executables created from go-spacemesh

Index

• Variables
• func AddCommands(cmd *cobra.Command)
• func EnsureCLIFlags(cmd *cobra.Command, appCFG *bc.Config)
• type BaseApp
  • func NewBaseApp() *BaseApp
  • func (app *BaseApp) Initialize(cmd *cobra.Command)

Variables

var (
	// Version is the app's semantic version. Designed to be overwritten by make.
	Version string

	// Branch is the git branch used to build the App. Designed to be overwritten by make.
	Branch string

	// Commit is the git commit used to build the app. Designed to be overwritten by make.
	Commit string

	// Ctx is the node's main context.
	Ctx, _ = context.WithCancel(context.Background())

	// Cancel is a function used to initiate graceful shutdown.
	Cancel = cancel
)

Functions

func AddCommands

func AddCommands(cmd *cobra.Command)

AddCommands adds cobra commands to the app.

func EnsureCLIFlags

func EnsureCLIFlags(cmd *cobra.Command, appCFG *bc.Config)

EnsureCLIFlags checks flag types and converts them

Types

type BaseApp

type BaseApp struct {
	Config *bc.Config
}

BaseApp is the base application command, provides basic init and flags for all executables and applications

func NewBaseApp

func NewBaseApp() *BaseApp

NewBaseApp returns new basic application

func (*BaseApp) Initialize

func (app *BaseApp) Initialize(cmd *cobra.Command)

Initialize loads config, sets logger and listens to Ctrl ^C