Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

process

package

Go to main page

Versions in this module

v1

v1.17.0

Feb 2, 2026

Changes in this version

type OutputWriter

+ func NewOutputWriterForPipe(typ contractsprocess.OutputType, key string, ...) *OutputWriter

+ func NewOutputWriterForProcess(typ contractsprocess.OutputType, handler contractsprocess.OnOutputFunc) *OutputWriter

+ type OutputWriterHandler func(typ contractsprocess.OutputType, line []byte, key string)

+ type Pipe struct

+ func (r *Pipe) Command(name string, args ...string) contractsprocess.PipeCommand

+ type PipeCommand struct

+ func NewPipeCommand(key, name string, args []string) *PipeCommand

+ func (r *PipeCommand) As(key string) contractsprocess.PipeCommand

+ func (r *PipeCommand) WithSpinner(message ...string) contractsprocess.PipeCommand

+ type Pipeline struct

+ func NewPipe() *Pipeline

+ func (r *Pipeline) DisableBuffering() contractsprocess.Pipeline

+ func (r *Pipeline) Env(vars map[string]string) contractsprocess.Pipeline

+ func (r *Pipeline) Input(in io.Reader) contractsprocess.Pipeline

+ func (r *Pipeline) OnOutput(onOutput contractsprocess.OnPipeOutputFunc) contractsprocess.Pipeline

+ func (r *Pipeline) Path(path string) contractsprocess.Pipeline

+ func (r *Pipeline) Pipe(configurer func(pipe contractsprocess.Pipe)) contractsprocess.Pipeline

+ func (r *Pipeline) Quietly() contractsprocess.Pipeline

+ func (r *Pipeline) Run() contractsprocess.Result

+ func (r *Pipeline) Start() (contractsprocess.RunningPipe, error)

+ func (r *Pipeline) Timeout(timeout time.Duration) contractsprocess.Pipeline

+ func (r *Pipeline) WithContext(ctx context.Context) contractsprocess.Pipeline

+ func (r *Pipeline) WithSpinner(message ...string) contractsprocess.Pipeline

+ type Pool struct

+ func (r *Pool) Command(name string, args ...string) contractsprocess.PoolCommand

+ type PoolBuilder struct

+ func NewPool() *PoolBuilder

+ func (r *PoolBuilder) Concurrency(n int) contractsprocess.PoolBuilder

+ func (r *PoolBuilder) OnOutput(handler contractsprocess.OnPoolOutputFunc) contractsprocess.PoolBuilder

+ func (r *PoolBuilder) Pool(configurer func(pool contractsprocess.Pool)) contractsprocess.PoolBuilder

+ func (r *PoolBuilder) Run() (map[string]contractsprocess.Result, error)

+ func (r *PoolBuilder) Start() (contractsprocess.RunningPool, error)

+ func (r *PoolBuilder) Timeout(timeout time.Duration) contractsprocess.PoolBuilder

+ func (r *PoolBuilder) WithContext(ctx context.Context) contractsprocess.PoolBuilder

+ func (r *PoolBuilder) WithSpinner(message ...string) contractsprocess.PoolBuilder

+ type PoolCommand struct

+ func NewPoolCommand(key, name string, args []string) *PoolCommand

+ func (r *PoolCommand) As(key string) contractsprocess.PoolCommand

+ func (r *PoolCommand) DisableBuffering() contractsprocess.PoolCommand

+ func (r *PoolCommand) Env(vars map[string]string) contractsprocess.PoolCommand

+ func (r *PoolCommand) Input(in io.Reader) contractsprocess.PoolCommand

+ func (r *PoolCommand) Path(path string) contractsprocess.PoolCommand

+ func (r *PoolCommand) Quietly() contractsprocess.PoolCommand

+ func (r *PoolCommand) Timeout(timeout time.Duration) contractsprocess.PoolCommand

+ func (r *PoolCommand) WithContext(ctx context.Context) contractsprocess.PoolCommand

type Process

+ func (r *Process) DisableBuffering() contractsprocess.Process

+ func (r *Process) Pipe(configurer func(pipe contractsprocess.Pipe)) contractsprocess.Pipeline

+ func (r *Process) Pool(configurer func(pool contractsprocess.Pool)) contractsprocess.PoolBuilder

+ func (r *Process) WithSpinner(message ...string) contractsprocess.Process

type Result

+ func (r *Result) Error() error

type Running

+ func (r *Running) Done() <-chan struct{}

+ type RunningPipe struct

+ func NewRunningPipe(ctx context.Context, commands []*exec.Cmd, pipeCommands []*PipeCommand, ...) *RunningPipe

+ func (r *RunningPipe) Done() <-chan struct{}

+ func (r *RunningPipe) PIDs() map[string]int

+ func (r *RunningPipe) Running() bool

+ func (r *RunningPipe) Signal(sig os.Signal) error

+ func (r *RunningPipe) Stop(timeout time.Duration, sig ...os.Signal) error

+ func (r *RunningPipe) Wait() contractsprocess.Result

+ type RunningPool struct

+ func NewRunningPool(ctx context.Context, cancel context.CancelFunc, keys []string, ...) *RunningPool

+ func (r *RunningPool) Done() <-chan struct{}

+ func (r *RunningPool) PIDs() map[string]int

+ func (r *RunningPool) Running() bool

+ func (r *RunningPool) Signal(sig os.Signal) error

+ func (r *RunningPool) Stop(timeout time.Duration, sig ...os.Signal) error

+ func (r *RunningPool) Wait() map[string]contractsprocess.Result

+ type ServiceProvider struct

+ func (r *ServiceProvider) Boot(_ foundation.Application)

+ func (r *ServiceProvider) Register(app foundation.Application)

+ func (r *ServiceProvider) Relationship() binding.Relationship

v1.16.2

Sep 9, 2025

v1.15.12

Sep 9, 2025

Changes in this version

+ type OutputWriter struct

+ func NewOutputWriter(typ contractsprocess.OutputType, handler contractsprocess.OnOutputFunc) *OutputWriter

+ func (w *OutputWriter) Write(p []byte) (n int, err error)

+ type Process struct

+ func New() *Process

+ func (r *Process) Env(vars map[string]string) contractsprocess.Process

+ func (r *Process) Input(in io.Reader) contractsprocess.Process

+ func (r *Process) OnOutput(handler contractsprocess.OnOutputFunc) contractsprocess.Process

+ func (r *Process) Path(path string) contractsprocess.Process

+ func (r *Process) Quietly() contractsprocess.Process

+ func (r *Process) Run(name string, args ...string) (contractsprocess.Result, error)

+ func (r *Process) Start(name string, args ...string) (contractsprocess.Running, error)

+ func (r *Process) TTY() contractsprocess.Process

+ func (r *Process) Timeout(timeout time.Duration) contractsprocess.Process

+ func (r *Process) WithContext(ctx context.Context) contractsprocess.Process

+ type Result struct

+ func NewResult(exitCode int, command, stdout, stderr string) *Result

+ func (r *Result) Command() string

+ func (r *Result) ErrorOutput() string

+ func (r *Result) ExitCode() int

+ func (r *Result) Failed() bool

+ func (r *Result) Output() string

+ func (r *Result) SeeInErrorOutput(needle string) bool

+ func (r *Result) SeeInOutput(needle string) bool

+ func (r *Result) Successful() bool

+ type Running struct

+ func NewRunning(cmd *exec.Cmd, stdout, stderr *bytes.Buffer) *Running

+ func (r *Running) Command() string

+ func (r *Running) ErrorOutput() string

+ func (r *Running) Kill() error

+ func (r *Running) LatestErrorOutput() string

+ func (r *Running) LatestOutput() string

+ func (r *Running) Output() string

+ func (r *Running) PID() int

+ func (r *Running) Running() bool

+ func (r *Running) Signal(sig os.Signal) error

+ func (r *Running) Stop(timeout time.Duration, sig ...os.Signal) error

+ func (r *Running) Wait() contractsprocess.Result