cli

Documentation

Index

• Constants
• type CLI
  • func NewCLI(wsConn ws.ConnectionHandler, input Inputer, output io.Writer) (*CLI, error)
  • func (c *CLI) Run(opts RunOptions) error
• type ConnectionHandler
• type ExecutionContext
  • func NewExecutionContext(cli *CLI, input <-chan keyboard.KeyEvent, outputFile io.Writer) *ExecutionContext
  • func (ctx *ExecutionContext) CmdEditor() command.Editor
  • func (ctx *ExecutionContext) Connection() ws.ConnectionHandler
  • func (ctx *ExecutionContext) Formater() formater.Formater
  • func (ctx *ExecutionContext) Input() <-chan keyboard.KeyEvent
  • func (ctx *ExecutionContext) Macro() *command.Macro
  • func (ctx *ExecutionContext) Output() io.Writer
  • func (ctx *ExecutionContext) OutputFile() io.Writer
  • func (ctx *ExecutionContext) RequestEditor() command.Editor
• type Formater
• type Inputer
• type Keyboard
  • func NewKeyboard() *Keyboard
  • func (k *Keyboard) Close()
  • func (k *Keyboard) GetKeys() (<-chan keyboard.KeyEvent, error)
• type RunOptions

Constants

const (
	MacroDir           = "macro"
	ConfigDir          = ".wsget"
	HistoryFilename    = ConfigDir + "/history"
	HistoryCmdFilename = ConfigDir + "/cmd_history"
	ConfigDirMode      = 0o755
	CommandsLimit      = 100
	HistoryLimit       = 100

	MacOSDeleteKey = 127

	HideCursor = "\x1b[?25l"
	ShowCursor = "\x1b[?25h"

	Bell = "\a"
)

const (
	KeyboardBufferSize = 10
)

Types

type CLI

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

func NewCLI

func NewCLI(wsConn ws.ConnectionHandler, input Inputer, output io.Writer) (*CLI, error)

NewCLI creates a new CLI instance with the given wsConn, input, and output. It returns an error if it fails to get the current user, create the necessary directories, load the macro for the domain, or initialize the CLI instance.

func (*CLI) Run

func (c *CLI) Run(opts RunOptions) error

Run runs the CLI with the provided options. It listens for user input and executes commands accordingly.

type ConnectionHandler

type ConnectionHandler interface {
	Messages() <-chan ws.Message
	Hostname() string
	Send(msg string) (*ws.Message, error)
	Close()
}

type ExecutionContext

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

func NewExecutionContext

func NewExecutionContext(cli *CLI, input <-chan keyboard.KeyEvent, outputFile io.Writer) *ExecutionContext

func (*ExecutionContext) CmdEditor

func (ctx *ExecutionContext) CmdEditor() command.Editor

func (*ExecutionContext) Connection

func (ctx *ExecutionContext) Connection() ws.ConnectionHandler

func (*ExecutionContext) Formater

func (ctx *ExecutionContext) Formater() formater.Formater

func (*ExecutionContext) Input

func (ctx *ExecutionContext) Input() <-chan keyboard.KeyEvent

func (*ExecutionContext) Macro

func (ctx *ExecutionContext) Macro() *command.Macro

func (*ExecutionContext) Output

func (ctx *ExecutionContext) Output() io.Writer

func (*ExecutionContext) OutputFile

func (ctx *ExecutionContext) OutputFile() io.Writer

func (*ExecutionContext) RequestEditor

func (ctx *ExecutionContext) RequestEditor() command.Editor

type Formater

type Formater interface {
	FormatMessage(wsMsg ws.Message) (string, error)
	FormatForFile(wsMsg ws.Message) (string, error)
}

type Inputer

type Inputer interface {
	GetKeys() (<-chan keyboard.KeyEvent, error)
	Close()
}

type Keyboard

type Keyboard struct{}

func NewKeyboard

func NewKeyboard() *Keyboard

func (*Keyboard) Close

func (k *Keyboard) Close()

func (*Keyboard) GetKeys

func (k *Keyboard) GetKeys() (<-chan keyboard.KeyEvent, error)

type RunOptions

type RunOptions struct {
	OutputFile *os.File
	Commands   []command.Executer
}