cmd

package

v3.5.0 Latest Latest Go to latest Published: Sep 24, 2021 License: Apache-2.0 Imports: 60 Imported by: 19

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/micro/micro

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// populated by ldflags
	GitCommit string
	GitTag    string
	BuildDate string
)

Functions ¶

func New ¶

func New(opts ...Option) *command

func Register ¶

func Register(cmds ...*cli.Command)

Register CLI commands

func Run ¶

func Run()

Run the default command

Types ¶

type Cmd ¶

type Cmd interface {
	// Init initialises options
	// Note: Use Run to parse command line
	Init(opts ...Option) error
	// Options set within this command
	Options() Options
	// The cli app within this cmd
	App() *cli.App
	// Run executes the command
	Run() error
	// Implementation
	String() string
}

var (
	DefaultCmd Cmd = New()
)

type Option ¶

type Option func(o *Options)

func Action ¶

func Action(a func(*cli.Context) error) Option

Action to execute

func Before ¶

func Before(f cli.BeforeFunc) Option

Before sets a function to be called before micro is setup

func Commands ¶

func Commands(c ...*cli.Command) Option

Commands to add

func Description ¶

func Description(d string) Option

Command line Description

func Flags ¶

func Flags(f ...cli.Flag) Option

Flags to add

func Name ¶

func Name(n string) Option

Command line Name

func SetupOnly ¶

func SetupOnly() Option

SetupOnly for to execute

func Version ¶

func Version(v string) Option

Command line Version

type Options ¶

type Options struct {
	// Name of the application
	Name string
	// Description of the application
	Description string
	// Version of the application
	Version string
	// Action to execute when Run is called and there is no subcommand
	Action func(*cli.Context) error
	// TODO replace with built in command definition
	Commands []*cli.Command
	// TODO replace with built in flags definition
	Flags []cli.Flag
	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cli Package cli is a command line interface	Package cli is a command line interface
auth
config
gen Package gen provides the micro gen command which simply runs go generate	Package gen provides the micro gen command which simply runs go generate
init Package init provides the micro init command for initialising plugins and imports	Package init provides the micro init command for initialising plugins and imports
namespace
network
new Package new generates micro service templates	Package new generates micro service templates
new/template
run Package runtime is the micro runtime Package runtime is the micro runtime	Package runtime is the micro runtime Package runtime is the micro runtime
store Package cli implements the `micro store` subcommands for example: micro store snapshot micro store restore micro store sync	Package cli implements the `micro store` subcommands for example: micro store snapshot micro store restore micro store sync
store/snapshot
token Package token contains CLI client token related helpers tToken files consist of one line per token, each token having the structure of `micro://envAddress/namespace[/id]:token`, ie.	Package token contains CLI client token related helpers tToken files consist of one line per token, each token having the structure of `micro://envAddress/namespace[/id]:token`, ie.
user Package user handles the user cli command	Package user handles the user cli command
util Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread	Package cliutil contains methods used across all cli commands @todo: get rid of os.Exits and use errors instread
protoc-gen-micro protoc-gen-micro is a plugin for the Google protocol buffer compiler to generate Go code.	protoc-gen-micro is a plugin for the Google protocol buffer compiler to generate Go code.
examples/greeter
generator The code generator for the plugin for the Google protocol buffer compiler.	The code generator for the plugin for the Google protocol buffer compiler.
plugin/micro
protoc-gen-openapi
converter
server Package server is the micro server which runs the whole system	Package server is the micro server which runs the whole system
service Package service provides micro service commands	Package service provides micro service commands
handler/exec
handler/file
usage Package usage tracks micro usage	Package usage tracks micro usage
client
proto
server

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