cliui

package module

v0.0.0-...-564e8e8 Latest Latest Go to latest Published: Aug 14, 2023 License: MIT Imports: 6 Imported by: 0

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/ershixiongTQL/cli-ui

Links

Open Source Insights

README ¶

cli-ui

Text-based command line style embedded user interface

Brief

This module is a "command line style" user interface. The interface will be rendered out according to a schema file, and internal functions will be linked to each user input by regular expressions.

Format and syntax of the schema file mentioned above is currentlly undecided.

Background

Project initial for a higher development efficiency of embedded network systems

Documentation ¶

Overview ¶

A simple cli-based user interface

Index ¶

type Agent
- func Create(frontType string, getPrompt func() string, getBanner func() string, ...) (agent *Agent)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Agent ¶

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

func Create ¶

func Create(frontType string, getPrompt func() string, getBanner func() string, backendConfigPath string, listenOn string) (agent *Agent)

func (*Agent) FrontEndType ¶

func (agent *Agent) FrontEndType() interfaces.UI_AGENT_FE_TYPE

func (*Agent) Start ¶

func (agent *Agent) Start() error

func (*Agent) Stop ¶

func (agent *Agent) Stop()

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
completer
frontendtelnet
protocol Package telnet provides simple interface for interacting with Telnet connection.	Package telnet provides simple interface for interacting with Telnet connection.
history
interfaces
router

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