command

package

v0.0.0-...-e46b4fa Latest Latest Go to latest Published: Jul 24, 2026 License: BSD-3-Clause, MIT Imports: 8 Imported by: 0

Details

Executes a command with a timeout.

Rendered for

This section is empty.

This section is empty.

func ExecForJSON(command string, args []string, obj any, timeout time.Duration, log Log) error

ExecForJSON runs a command (with timeout) expecting JSON output with obj interface

type Log interface {
	Debugf(s string, args ...any)
	Infof(s string, args ...any)
	Warningf(s string, args ...any)
	Errorf(s string, args ...any)
}

Log is the logging interface for the command package

type Program struct {
	Path string
	Args []string
}

Program is a program at path with arguments

func (p Program) ArgsWith(args []string) []string

ArgsWith returns program args with passed in args

type Result struct {
	Stdout  bytes.Buffer
	Stderr  bytes.Buffer
	Process *os.Process
}

Result is the result of running a command

func Exec(name string, args []string, timeout time.Duration, log Log) (Result, error)

Exec runs a command and returns the stdout/err output and error if any

func ExecWithEnv(name string, args []string, env []string, timeout time.Duration, log Log) (Result, error)

ExecWithEnv runs a command with an environment and returns the stdout/err output and error if any

func (r Result) CombinedOutput() string

CombinedOutput returns Stdout and Stderr as a single string.