Help us shape the future of Go! Take the 2026 Go Developer Survey

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
- API
  
  Reference documentation for the pkg.go.dev API
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

subprocess

package

Go to main page

Versions in this module

v0

v0.11.0

Oct 22, 2026

Changes in this version

type SessionOption

+ func WithControlPersist(d time.Duration) SessionOption

v0.10.2

Oct 21, 2026

v0.10.1

Oct 21, 2026

v0.10.0

Oct 21, 2026

Changes in this version

+ type SessionOption func(*Session)

+ func WithSessionValue(key any, newValue func() any) SessionOption

v0.9.2

Oct 16, 2026

v0.9.1

Oct 16, 2026

Changes in this version

+ func ValidateSSHOptions(opts []string) error

type Target

+ IdentityFile string

+ SSHOptions []string

v0.9.0

Oct 14, 2026

Changes in this version

+ const MaskPlaceholder

+ var ErrSessionClosed = errors.New("ssh session is closed")

+ func CloseSshControlMaster(host string) error

+ func ContextWithMasker(ctx context.Context, m *Masker) context.Context

+ func ContextWithRunner(ctx context.Context, fn ExecRunner) context.Context

+ func ContextWithTarget(ctx context.Context, target Target) context.Context

+ func Probe(ctx context.Context, input ExecCommandInput) (bool, error)

+ func ResolveCommandString(ctx context.Context, input ExecCommandInput) string

+ func ValidateHost(raw string) error

+ type ExecCommandInput struct

+ Args []string

+ Command string

+ StderrWriter io.Writer

+ Stdin io.Reader

+ StdoutWriter io.Writer

+ StreamStderr bool

+ StreamStdio bool

+ StreamStdout bool

+ type ExecCommandResponse struct

+ Cancelled bool

+ Command string

+ ExitCode int

+ Stderr string

+ Stdout string

+ func CallExecCommand(ctx context.Context, input ExecCommandInput) (ExecCommandResponse, error)

+ func CallSshCommand(ctx context.Context, target Target, input ExecCommandInput) (ExecCommandResponse, error)

+ func ProbeCode(ctx context.Context, input ExecCommandInput) (ExecCommandResponse, error)

+ func (ecr ExecCommandResponse) StderrBytes() []byte

+ func (ecr ExecCommandResponse) StderrContents() string

+ func (ecr ExecCommandResponse) StdoutBytes() []byte

+ func (ecr ExecCommandResponse) StdoutContents() string

+ type ExecError struct

+ Err error

+ Ran bool

+ Response ExecCommandResponse

+ func (e *ExecError) Error() string

+ func (e *ExecError) Unwrap() error

+ type ExecRunner func(ctx context.Context, input ExecCommandInput) (ExecCommandResponse, error)

+ type Masker struct

+ func MaskerFromContext(ctx context.Context) *Masker

+ func NewMasker(values ...string) *Masker

+ func (m *Masker) Add(values ...string)

+ func (m *Masker) String(s string) string

+ func (m *Masker) Value(v interface{}) interface{}

+ func (m *Masker) Values() []string

+ type SSHError struct

+ Command []string

+ Err error

+ Host string

+ Stderr string

+ func (e *SSHError) Error() string

+ func (e *SSHError) Unwrap() error

+ type Session struct

+ func NewSession(masker *Masker) *Session

+ func (s *Session) Close() error

+ func (s *Session) Context(parent context.Context, target Target) context.Context

+ type Target struct

+ AcceptNewHostKeys bool

+ Host string

+ Sudo bool

+ func TargetFromContext(ctx context.Context) Target