package
0.0.0-20250305165956-269064b29c6f
Repository: https://github.com/bryk-io/pkg.git
Documentation: pkg.go.dev

# Functions

New ready-to-use interactive shell instance based on the provided configuration options.
WithExitCommands provides a list of reserved keywords to let the user close a running shell instance.
WithExitMessage set a message to be printed just before the shell is closed.
WithHelpCommands provides a list of reserved keywords to present a list of available top commands to the user.
WithHelpMessage set a message to be printed along the command list for the user.
WithHistoryFile adjust the location to store a log of tasks executed in the shell.
WithHistoryLimit set the maximum number of items to store in the shell history, set to 0 to disable it.
WithPrompt set the CLI prompt value used by the shell.
WithResetHook set a custom behavior to run just after the shell state is reset.
WithStartHook set a custom behavior to run before the shell instance is started.
WithStartMessage set a message to be printed just after the shell is started.
WithStopHook set a custom behavior to run before the shell instance is closed.

# Structs

Command provides a mechanism to add functionality to a shell instance.
Instance defines the main interface for an interactive shell.

# Type aliases

Hook provides a mechanism to extend the shell functionality during several moments of its lifecycle.
Option provides a functional method to adjust the settings on a shell instance.