Built-in Commands

posh ships a small set of ready-made commands you can register inside your Plugin. All of them live in pkg/command and are constructed with command.New<Name>(l, opts...).

exit

Exits the prompt loop. Equivalent to typing Ctrl+D. Use this so users can quit without remembering shell shortcuts.

inst.commands.Add(command.NewExit(l))

No options. No flags. Implementing Shutdowner on your own commands is what runs during the exit.

help

Lists every command with a Description(), and prints the long help for any command that implements the Helper interface.

inst.commands.Add(command.NewHelp(l, inst.commands))

Note that help takes the entire commands registry — it discovers commands by reflection, so it sees whatever you add later in the constructor.

posh › help
Help about all available commands.

Usage:
  help [command]

Available Commands:
  exit                exit shell
  help                print help
  history             print history
  welcome             print a welcome message

posh › help welcome
Print a welcome message

Usage:
welcome

history

Added automatically by pkg/prompt whenever a non-noop history backend is configured — you don't register it manually. It prints the persisted history file.

welcome (scaffolded)

Not technically a built-in — it's the seed example in embed/scaffold/init/$.posh/internal/command/welcome.go.gotext. It demonstrates the smallest plausible command:

• Reads welcome.message from .posh.yaml via viper.UnmarshalKey
• Implements Name, Description, Execute, Help
• Uses WelcomeWithConfigKey("welcome") as a functional option

Treat it as a template for your own commands and replace it once you've internalised the pattern.

Other helpers in pkg/command

These aren't always-on built-ins, but the package ships a few more constructors for common needs:

Constructor	Purpose
command.NewCache(...)	A scoped cache around expensive completions or lookups
command.NewCheck(...)	Wraps a check.Checker as a callable command
command.NewEnv(...)	Prints / inspects the shell's environment

See the godoc for current signatures: https://pkg.go.dev/github.com/foomo/posh/pkg/command.