cmd

Documentation

Index

• Variables
• func Execute() error
• type ErrExitCode
  • func (e ErrExitCode) Error() string
• type ErrUsage
  • func (e ErrUsage) Error() string

Variables

var (
	RootCmd = &cobra.Command{
		Use:           "aurora",
		Short:         "client-facing api server for the Hcnet network",
		SilenceErrors: true,
		SilenceUsage:  true,
		Long: "Client-facing API server for the Hcnet network. It acts as the interface between Hcnet Core " +
			"and applications that want to access the Hcnet network. It allows you to submit transactions to the " +
			"network, check the status of accounts, subscribe to event streams and more.\n" +
			"DEPRECATED - the use of command-line flags has been deprecated in favor of environment variables. Please" +
			"consult our Configuring section in the developer documentation on how to use them - https://developers.hcnet.org/docs/run-api-server/configuring",
		RunE: func(cmd *cobra.Command, args []string) error {
			app, err := aurora.NewAppFromFlags(globalConfig, globalFlags)
			if err != nil {
				return err
			}
			return app.Serve()
		},
	}
)

Functions

func Execute

func Execute() error

Types

type ErrExitCode

type ErrExitCode int

ErrExitCode Indicates we want to exit with a specific error code without printing an error.

func (ErrExitCode) Error

func (e ErrExitCode) Error() string

type ErrUsage

type ErrUsage struct {
	// contains filtered or unexported fields
}

ErrUsage indicates we should print the usage string and exit with code 1

func (ErrUsage) Error

func (e ErrUsage) Error() string