config

Documentation

Index

• type Config
  • func Default() *Config

Types

type Config

type Config struct {
	// The file to store the history in (if not absolute will be relative to $HOME)
	//
	// If blank no history will be stored
	HistoryFile string

	KeyMap keymap.KeyMap // The key map to use
	Styles styles.Styles // The styles to use

	MaxStackFrames int // The maximum number of stack frames to show in errors

	// Packages to filter from the stack trace rendering of errors
	//
	// By default the shell will filter out packages related to running
	// the shell itself as well as the Go runtime package.
	//
	// If empty no filtering will be done
	PackagesToFilterFromStack []string

	// InlineShell will cause the shell to be rendered inline
	// rather than taking over the whole terminal
	InlineShell bool

	// RootContext is the context that will be used for the
	// commands when they run
	RootContext context.Context

	// PromptFunc is a function that returns the prompt to be used
	PromptFunc func() string
}

Config is the configuration for the shell

func Default

func Default() *Config

Default returns a default configuration for the shell