cli

package

v0.0.0-sei-fork Latest Latest Go to latest Published: Mar 7, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/badrootd/sei-tendermint

Documentation ¶

Index ¶

Constants
func BindFlagsLoadViper(cmd *cobra.Command, args []string) error
func InitEnv(prefix string)
func NewCompletionCmd(rootCmd *cobra.Command, hidden bool) *cobra.Command
func PrepareBaseCmd(cmd *cobra.Command, envPrefix, defaultHome string) *cobra.Command
func RunWithArgs(ctx context.Context, cmd *cobra.Command, args []string, env map[string]string) error
func RunWithTrace(ctx context.Context, cmd *cobra.Command) error
func WriteConfigVals(dir string, vals map[string]string) error
type Executable
type Executor
- func (e Executor) Execute() error
type ExitCoder

Constants ¶

View Source

const (
	HomeFlag   = "home"
	TraceFlag  = "trace"
	OutputFlag = "output" // used in the cli
)

Variables ¶

This section is empty.

Functions ¶

func BindFlagsLoadViper ¶

func BindFlagsLoadViper(cmd *cobra.Command, args []string) error

Bind all flags and read the config into viper

func InitEnv ¶

func InitEnv(prefix string)

InitEnv sets to use ENV variables if set.

func NewCompletionCmd ¶

func NewCompletionCmd(rootCmd *cobra.Command, hidden bool) *cobra.Command

NewCompletionCmd returns a cobra.Command that generates bash and zsh completion scripts for the given root command. If hidden is true, the command will not show up in the root command's list of available commands.

func PrepareBaseCmd ¶

func PrepareBaseCmd(cmd *cobra.Command, envPrefix, defaultHome string) *cobra.Command

PrepareBaseCmd is meant for tendermint and other servers

func RunWithArgs ¶

func RunWithArgs(ctx context.Context, cmd *cobra.Command, args []string, env map[string]string) error

RunWithArgs executes the given command with the specified command line args and environmental variables set. It returns any error returned from cmd.Execute()

This is only used in testing.

func RunWithTrace ¶

func RunWithTrace(ctx context.Context, cmd *cobra.Command) error

func WriteConfigVals ¶

func WriteConfigVals(dir string, vals map[string]string) error

WriteConfigVals writes a toml file with the given values. It returns an error if writing was impossible.

Types ¶

type Executable ¶

type Executable interface {
	Execute() error
}

type Executor ¶

type Executor struct {
	*cobra.Command
	Exit func(int) // this is os.Exit by default, override in tests
}

Executor wraps the cobra Command with a nicer Execute method

func (Executor) Execute ¶

func (e Executor) Execute() error

execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

type ExitCoder ¶

type ExitCoder interface {
	ExitCode() int
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
flags

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL