shell

Documentation

Index

• Constants
• Variables
• func ServerCell(defaultSocketPath string) cell.Cell
• func ShellCmd(defaultSockPath string, prompt string, printGreeting func(w io.Writer)) *cobra.Command
• func ShellExchange(c Config, w io.Writer, format string, args ...any) error
• type Config
  • func (def Config) Flags(flags *pflag.FlagSet)
  • func (cfg *Config) Parse(flags *pflag.FlagSet) (err error)

Constants

const ShellSockPathName = "shell-sock-path"

Variables

var DefaultConfig = Config{ShellSockPath: ""}

Functions

func ServerCell

func ServerCell(defaultSocketPath string) cell.Cell

func ShellCmd

func ShellCmd(defaultSockPath string, prompt string, printGreeting func(w io.Writer)) *cobra.Command

ShellCmd constructs a cobra command for dialing a shell server.

func ShellExchange

func ShellExchange(c Config, w io.Writer, format string, args ...any) error

ShellExchange sends a single command to the shell. Output is written to the given writer [w].

Types

type Config

type Config struct {
	ShellSockPath string
}

Config is the configuration for the shell server.

func (Config) Flags

func (def Config) Flags(flags *pflag.FlagSet)

Flags adds flags for Config when running the shell server Cell.

func (*Config) Parse

func (cfg *Config) Parse(flags *pflag.FlagSet) (err error)

Parse the config from the flags.