commander

Documentation

Index

• Constants
• Variables
• func GetCmd(c *cli.Context) (cmd string)
• func GetHostList(hostsArg, prefer string) (list hostlist.HostInfoList, err error)
• func Init()
• func PrepareExecutor(c *cli.Context) *executor.Executor
• func Run() error
• func SetupFormatter(c *cli.Context, exe *executor.Executor) (err error)
• func SetupParameter(c *cli.Context) executor.Parameter

Constants

const (
	PIPEEMTPY          = ""
	PIPEUSEDBYHOSTLIST = "_PIPE_USED_BY_HOSTLIST"
	PIPEUSEDBYCMD      = "_PIPE_USED_BY_CMD"
)

Input From Pipe/HereDoc

Variables

var AccountFlag = cli.StringFlag{
	Name:   "account",
	Usage:  "Some Executors need an Account to initiate",
	EnvVar: "ACCOUNT",
}

AccountFlag `--account`

var ConcurrencyFlag = cli.IntFlag{
	Name:   "concurrency, c",
	Value:  1,
	Usage:  "Concurrency",
	EnvVar: "CONCURRENCY",
}

ConcurrencyFlag `-c`

var HostsFlag = cli.StringFlag{
	Name:  "hosts, f",
	Usage: "Hostname List",
}

HostsFlag `-f`

var JSONFlag = cli.BoolFlag{
	Name:  "json, j",
	Usage: "Prints in JSON",
}

JSONFlag `-j`

var MethodFlag = cli.StringFlag{
	Name:   "method, m",
	Value:  "ssh",
	EnvVar: "METHOD",
	Usage:  "How to execute the commands",
}

MethodFlag `-m`

var PasswdFlag = cli.BoolFlag{
	Name:  "passwd, p",
	Usage: "Add Password Authentication Method",
}

PasswdFlag `-p`

var PasswordFlag = cli.StringFlag{
	Name:   "password",
	EnvVar: "PASSWORD",
	Usage:  "Specify password in Command Line",
}

PasswordFlag `--password`

var PreferFlag = cli.StringFlag{
	Name:   "prefer",
	EnvVar: "PREFER",
	Usage:  "Override default hostlist lookup chain",
}

PreferFlag `--prefer`

var RetryFlag = cli.IntFlag{
	Name:  "retry",
	Usage: "Retry",
	Value: 0,
}

RetryFlag `--retry`

var TimeoutFlag = cli.IntFlag{
	Name:  "timeout, t",
	Usage: "Timeout. Unit: s",
	Value: 0,
}

TimeoutFlag `-t`

var UserFlag = cli.StringFlag{
	Name:   "user, u",
	Usage:  "Username",
	EnvVar: "USER,USER",
}

UserFlag `-u`

var WindowFlag = cli.BoolFlag{
	Name:  "window, w",
	Usage: "Vim-like Command-Line User Interface",
}

WindowFlag `-w`

Functions

func GetCmd

func GetCmd(c *cli.Context) (cmd string)

GetCmd extracts cmd from command line

func GetHostList

func GetHostList(hostsArg, prefer string) (list hostlist.HostInfoList, err error)

GetHostList gets hostlist from flag/pipe

@hostsArg: argument for hostlist to generate HostInfoList
@prefer: preferred method to get hostlist(PreferFlag)

func Init

func Init()

Init collects all Commands

func PrepareExecutor

func PrepareExecutor(c *cli.Context) *executor.Executor

PrepareExecutor fills Executor

func Run

func Run() error

Run starts gsck

func SetupFormatter

func SetupFormatter(c *cli.Context, exe *executor.Executor) (err error)

SetupFormatter *MUST* be called after hostlist is ready

func SetupParameter

func SetupParameter(c *cli.Context) executor.Parameter

SetupParameter translates cli flags into Parameter