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

local

package

Go to main page

Versions in this module

v0

v0.8.0

May 5, 2026

Changes in this version

type Script

+ func (s *Script) WithBundleDest(d string) *Script

+ func (s *Script) WithForceNoSudoForBundle(f bool) *Script

v0.7.0

Apr 30, 2026

v0.6.0

Apr 29, 2026

v0.5.0

Apr 13, 2026

v0.4.0

Apr 1, 2026

v0.3.0

Mar 31, 2026

v0.2.0

Feb 10, 2026

v0.1.0

Feb 9, 2026

Changes in this version

+ type Command struct

+ func NewCommand(sett settings.Settings, program string, args ...string) *Command

+ func (c *Command) Cmd(_ context.Context)

+ func (c *Command) CombinedOutput(ctx context.Context) ([]byte, error)

+ func (c *Command) OnCommandStart(fn func())

+ func (c *Command) Output(ctx context.Context) ([]byte, []byte, error)

+ func (c *Command) Run(ctx context.Context) error

+ func (c *Command) StderrBytes() []byte

+ func (c *Command) StdoutBytes() []byte

+ func (c *Command) Sudo(_ context.Context)

+ func (c *Command) WithEnv(env map[string]string)

+ func (c *Command) WithSSHArgs(_ ...string)

+ func (c *Command) WithStderrHandler(h func(line string))

+ func (c *Command) WithStdoutHandler(h func(line string))

+ func (c *Command) WithTimeout(t time.Duration)

+ type File struct

+ func NewFile() *File

+ func (File) Download(_ context.Context, srcPath, dstPath string) error

+ func (File) DownloadBytes(_ context.Context, srcPath string) ([]byte, error)

+ func (File) Upload(_ context.Context, srcPath, dstPath string) error

+ func (File) UploadBytes(_ context.Context, data []byte, dstPath string) error

+ type NodeInterface struct

+ func NewDefaultNodeInterface() *NodeInterface

+ func NewNodeInterface(sett settings.Settings) *NodeInterface

+ func (n *NodeInterface) Command(name string, args ...string) connection.Command

+ func (n *NodeInterface) File() connection.File

+ func (n *NodeInterface) UploadScript(scriptPath string, args ...string) connection.Script

+ type Script struct

+ func NewScript(sett settings.Settings, path string, args ...string) *Script

+ func (s *Script) Execute(ctx context.Context) ([]byte, error)

+ func (s *Script) ExecuteBundle(ctx context.Context, parentDir, bundleDir string) ([]byte, error)

+ func (s *Script) Sudo()

+ func (s *Script) WithBundlerOpts(opts ...connection.BundlerOption)

+ func (s *Script) WithCleanupAfterExec(doCleanup bool)

+ func (s *Script) WithEnvs(envs map[string]string)

+ func (s *Script) WithExecuteUploadDir(string)

+ func (s *Script) WithNoLogStepOutOnError(bool)

+ func (s *Script) WithStdoutHandler(handler func(string))

+ func (s *Script) WithTimeout(timeout time.Duration)