cli

Documentation

Overview

Package cli provides all methods to control command line functions

Index

• func CMDRgx() *regexp.Regexp
• func Flag(args string) (string, map[string]interface{})
• func GetCMDNames(s interface{}) []string
• func GetOptions(s interface{}, key string) ([]string, []interface{})
• func InitConfig(f string) ([]byte, error)
• func SetConfig(args string, s *Config) error
• func SetFlag(flag map[string]interface{}, option string, v interface{}) interface{}
• func SetValue(v reflect.Value, rec string, val interface{}) error
• func ShowConfig(s *Config)
• func UpgradeConfig(cfg *Config) error
• func WriteConfig(cfg Config) error
• type Config
  • func LoadConfig() Config
  • func ReadConfig() Config
  • func ReadDefaultConfig() (Config, error)
• type HPing
• type Ping
• type Readline
  • func Init(version string) *Readline
  • func (r *Readline) AddCompleter(pcItem string, pcSubItems []string)
  • func (r *Readline) Close(next chan struct{})
  • func (r *Readline) GetPrompt() string
  • func (r *Readline) Help()
  • func (r *Readline) Next()
  • func (r *Readline) Refresh()
  • func (r *Readline) RemoveItemCompleter(pcItem string)
  • func (r *Readline) Run(cmd chan<- string, next chan struct{})
  • func (r *Readline) SetEmacs()
  • func (r *Readline) SetPrompt(p string)
  • func (r *Readline) SetVim()
  • func (r *Readline) UpdateCompleter(pcItem string, pcSubItems []string)
  • func (r *Readline) UpdatePromptN(p string, n int)
• type SNMP
• type Scan
• type Trace
• type Web

Functions

func CMDRgx

func CMDRgx() *regexp.Regexp

CMDRgx returns commands regex for validation

func Flag

func Flag(args string) (string, map[string]interface{})

Flag parses the command arguments syntax: -flag=x -flag x help

func GetCMDNames

func GetCMDNames(s interface{}) []string

GetCMDNames returns command line names

func GetOptions

func GetOptions(s interface{}, key string) ([]string, []interface{})

GetOptions returns option(s)/value(s) for specific command

func InitConfig

func InitConfig(f string) ([]byte, error)

InitConfig creates new config file

func SetConfig

func SetConfig(args string, s *Config) error

SetConfig handles update option's value

func SetFlag

func SetFlag(flag map[string]interface{}, option string, v interface{}) interface{}

SetFlag returns command option(s)

func SetValue

func SetValue(v reflect.Value, rec string, val interface{}) error

SetValue set optioni's value

func ShowConfig

func ShowConfig(s *Config)

ShowConfig prints the configuration

func UpgradeConfig

func UpgradeConfig(cfg *Config) error

UpgradeConfig adds / removes new command(s)/option(s)

func WriteConfig

func WriteConfig(cfg Config) error

WriteConfig write config to disk

Types

type Config

type Config struct {
	Ping  Ping  `json:"ping"`
	Hping HPing `json:"hping"`
	Web   Web   `json:"web"`
	Scan  Scan  `json:"scan"`
	Trace Trace `json:"trace"`
	Snmp  SNMP  `json:"snmp"`
}

Config represents configuration

func LoadConfig

func LoadConfig() Config

LoadConfig loads configuration

func ReadConfig

func ReadConfig() Config

ReadConfig reads configuration from existing or default configuration

func ReadDefaultConfig

func ReadDefaultConfig() (Config, error)

ReadDefaultConfig returns default configuration

type HPing

type HPing struct {
	Timeout string `json:"timeout"`
	Method  string `json:"method"`
	Data    string `json:"data"`
	Count   int    `json:"count"`
}

HPing represents ping command options

type Ping

type Ping struct {
	Timeout  string `json:"timeout"`
	Interval string `json:"interval"`
	Count    int    `json:"count"`
}

Ping represents ping command options

type Readline

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

Readline structure

func Init

func Init(version string) *Readline

Init set readline imain items

func (*Readline) AddCompleter

func (r *Readline) AddCompleter(pcItem string, pcSubItems []string)

AddCompleter updates subitem(s) from a specific main item

func (*Readline) Close

func (r *Readline) Close(next chan struct{})

Close the readline instance

func (*Readline) GetPrompt

func (r *Readline) GetPrompt() string

GetPrompt returns the current prompt string

func (*Readline) Help

func (r *Readline) Help()

Help print out the main help

func (*Readline) Next

func (r *Readline) Next()

Next trigers to read next line

func (*Readline) Refresh

func (r *Readline) Refresh()

Refresh prompt

func (*Readline) RemoveItemCompleter

func (r *Readline) RemoveItemCompleter(pcItem string)

RemoveItemCompleter removes subitem(s) from a specific main item

func (*Readline) Run

func (r *Readline) Run(cmd chan<- string, next chan struct{})

Run the main loop

func (*Readline) SetEmacs

func (r *Readline) SetEmacs()

SetEmacs set mode to emacs

func (*Readline) SetPrompt

func (r *Readline) SetPrompt(p string)

SetPrompt set readline prompt and store it

func (*Readline) SetVim

func (r *Readline) SetVim()

SetVim set mode to vim

func (*Readline) UpdateCompleter

func (r *Readline) UpdateCompleter(pcItem string, pcSubItems []string)

UpdateCompleter updates subitem(s) from a specific main item

func (*Readline) UpdatePromptN

func (r *Readline) UpdatePromptN(p string, n int)

UpdatePromptN appends readline prompt

type SNMP

type SNMP struct {
	Community     string `json:"community"`
	Timeout       string `json:"timeout"`
	Version       string `json:"version"`
	Retries       int    `json:"retries"`
	Port          int    `json:"port"`
	Securitylevel string `json:"securitylevel"`
	Authpass      string `json:"authpass"`
	Authproto     string `json:"authproto"`
	Privacypass   string `json:"privacypass"`
	Privacyproto  string `json:"privacyproto"`
}

SNMP represents nms command options

type Scan

type Scan struct {
	Port string `json:"port"`
}

Scan represents scan command options

type Trace

type Trace struct {
	Wait  string `json:"wait"`
	Theme string `json:"theme"`
}

Trace represents trace command options

type Web

type Web struct {
	Port    int    `json:"port"`
	Address string `json:"address"`
}

Web represents web command options