package
0.2.11
Repository: https://github.com/elastic/harp.git
Documentation: pkg.go.dev

# Functions

BugReport generates a bug report body nolint:godox // Bug not allow in documentation.
Context initializes a command context.
DirectWriter returns the given writer.
DiscardWriter returns discard writer.
Examples normalizes a command's examples to follow the conventions.
Expand a given path using `~` notation for HOMEDIR.
FileReader returns lazy evaluated reader.
FileWriter returns lazy evaluated writer.
HandlePluginCommand receives a pluginHandler and command-line arguments and attempts to find a plugin executable on the PATH that satisfies the given arguments.
LineReader creates a reder and returns content read line by line.
LongDesc normalizes a command's long description to follow the conventions.
NewClosedWriter returns a io.WriteCloser instance which always fails when writing data.
NewDefaultPluginHandler instantiates the DefaultPluginHandler with a list of given filename prefixes used to identify valid plugin filenames.
NewTimeoutReader create a timed-out limited reader instance.
Reader creates a reader instance according to the given name value Use "" or "-" for Stdin reader, else use a filename.
ReadSecret reads password from Stdin and returns a lockedbuffer.
StdoutWriter returns lazy evaluated writer.
Writer creates a writer according to the given name value Use "" or "-" for Stdout writer, else use a filename.

# Constants

No description provided by the author
MaxReaderLimitSize is the upper limit for reader capability.
ReaderTimeout is a time limit during the reader is waiting for data.

# Variables

ErrNoHome is raised when tilde expansion failed.

# Structs

DefaultPluginHandler implements PluginHandler.
TimeoutReader implemnts a timelimited reader.

# Interfaces

PluginHandler is capable of parsing command line arguments and performing executable filename lookups to search for valid plugin files, and execute found plugins.