exec

Documentation

Overview

Package exec provides a wrapper around the os/exec package

Index

• func Cmd(command string, args ...string) (string, string, error)
• func CmdWithContext(ctx context.Context, config Config, command string, args ...string) (string, string, error)
• func CmdWithPrint(command string, args ...string) error
• func CmdWithTesting(t *testing.T, config Config, command string, args ...string) (string, string, error)
• func GetOSShell(shellPref v1alpha1.Shell) (string, []string)
• func IsPowershell(shellName string) bool
• func LaunchURL(url string) error
• type Config
  • func PrintCfg() Config

Functions

func Cmd

func Cmd(command string, args ...string) (string, string, error)

Cmd executes a given command with given config.

func CmdWithContext

func CmdWithContext(ctx context.Context, config Config, command string, args ...string) (string, string, error)

CmdWithContext executes a given command with given config.

func CmdWithPrint

func CmdWithPrint(command string, args ...string) error

CmdWithPrint executes a given command with given config and prints the command.

func CmdWithTesting

func CmdWithTesting(t *testing.T, config Config, command string, args ...string) (string, string, error)

CmdWithTesting takes a *testing.T and generates a context the cancels on cleanup

func GetOSShell

func GetOSShell(shellPref v1alpha1.Shell) (string, []string)

GetOSShell returns the shell and shellArgs based on the current OS

func IsPowershell

func IsPowershell(shellName string) bool

IsPowershell returns whether a shell name is powershell

func LaunchURL

func LaunchURL(url string) error

LaunchURL opens a URL in the default browser.

Types

type Config

type Config struct {
	Print          bool
	Dir            string
	Env            []string
	CommandPrinter func(format string, a ...any)
	Stdout         io.Writer
	Stderr         io.Writer
}

Config is a struct for configuring the Cmd function.

func PrintCfg

func PrintCfg() Config

PrintCfg is a helper function for returning a Config struct with Print set to true.