cli

Documentation

Overview

Package cli provides all methods to control command line functions

Index

• Variables
• func Flag(args string) (string, map[string]interface{})
• func SetFlag(flag map[string]interface{}, option string, v interface{}) interface{}
• type Readline
  • func Init(prompt, 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)

Variables

var (
	// validation command regex
	CMDReg, _ = regexp.Compile(
		`(ping|trace|bgp|lg|ns|dig|dump|disc|whois|peering|scan|hping|connect|node|local|mode|help|web|exit|quit)\s{0,1}(.*)`)
)

Functions

func Flag

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

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

func SetFlag

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

SetFlag returns command option(s)

Types

type Readline

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

Readline structure

func Init

func Init(prompt, 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