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

dev

package

Go to main page

Versions in this module

v3

v3.2.0-nightly.20261102

Nov 2, 2026

v3.2.0-nightly.20261101

Nov 1, 2026

v3.1.0

Nov 1, 2026

Changes in this version

+ func FrontendSessionChanged(current, next manifest.Config) bool

+ func Generation(ctx context.Context) uint64

+ func IsForcedRebuild(ctx context.Context) bool

+ func Run(ctx context.Context, options Options, ops Operations) (resultErr error)

+ func WaitHTTP(ctx context.Context, p Process, address string, timeout time.Duration) error

+ func WatchSessionChanged(current, next manifest.Config) bool

+ func WithForcedRebuild(ctx context.Context) context.Context

+ func WithGeneration(ctx context.Context, g uint64) context.Context

+ func WithOutput(ctx context.Context, o *Output) context.Context

+ type BuildResult struct

+ Plan pipeline.Plan

+ Results map[pipeline.NodeKey]pipeline.Result

+ type Diagnostic struct

+ Command []string

+ Component string

+ Err error

+ ExitCode int

+ Generation uint64

+ Output string

+ Phase string

+ func (d *Diagnostic) Error() string

+ func (d *Diagnostic) Unwrap() error

+ type Event struct

+ Component string

+ Diagnostic *Diagnostic

+ Generation uint64

+ Message string

+ Phase string

+ type EventKind int

+ const Directory

+ const GitIgnore

+ const Ignore

+ const Source

+ type Operations struct

+ BackendChanged func(BuildResult, string, string) bool

+ BinaryPath func(string, BuildResult, string, string) (string, error)

+ Build func(context.Context, *manifest.Loaded, string, string, string, int) (BuildResult, error)

+ CheckPort func(string, int) error

+ GenerateBindings func(context.Context, *manifest.Loaded) error

+ Getwd func() (string, error)

+ Load func(string, string) (*manifest.Loaded, error)

+ Plan func(*manifest.Loaded, string, string, []string) error

+ RestartWatches func(string, manifest.Config, WatchSet) (WatchSet, error)

+ RestoreApp func(context.Context, string, Process, string, int) (Process, error)

+ RestoreFrontend func(context.Context, string, manifest.Config, int, string, string) (Process, error)

+ StartApp func(string, string, string, int, []string) (Process, error)

+ StartFrontend func(string, manifest.Config, string, int, string) (Process, error)

+ StartWatches func(string, manifest.Config) (WatchSet, error)

+ Target func(string) (string, string, error)

+ ValidateTarget func(string, string) error

+ WaitFrontendReady func(context.Context, Process, string, time.Duration) error

+ WaitReady func(context.Context, Process, time.Duration) error

+ type Options struct

+ Args []string

+ Controls <-chan string

+ Host string

+ Output *Output

+ Plan bool

+ Profile string

+ Secure bool

+ Target string

+ VitePort int

+ type Output struct

+ func NewOutput(w io.Writer, level report.Verbosity) *Output

+ func OutputFrom(ctx context.Context) *Output

+ func (o *Output) BuildReporter(generation ...uint64) report.Reporter

+ func (o *Output) Clear()

+ func (o *Output) Failure(g uint64, c, p string, err error, message string)

+ func (o *Output) Observe(f func(Event))

+ func (o *Output) Status(g uint64, c, p, m string)

+ func (o *Output) Writer(component, stream string) io.WriteCloser

+ type Process interface

+ Done func() <-chan struct{}

+ Err func() error

+ NeedsStopBeforeReplacement func() bool

+ Stop func(time.Duration)

+ type Readiness struct

+ func NewReadiness() (*Readiness, error)

+ func NewReadinessOn(host string) (*Readiness, error)

+ func (r *Readiness) Close()

+ func (r *Readiness) Environment() []string

+ func (r *Readiness) Port() string

+ func (r *Readiness) Wait(ctx context.Context, p Process, timeout time.Duration) error

+ type Tail struct

+ func (t *Tail) String() string

+ func (t *Tail) Write(p []byte) (int, error)

+ type WatchSet interface

+ Classify func(manifest.Config, notify.EventInfo) EventKind

+ ContainsInput func(manifest.Config, string) bool

+ Events func() <-chan notify.EventInfo

+ Stop func()