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

api

package

Go to main page

Versions in this module

v1

v1.6.0

May 19, 2026

v1.5.0

May 8, 2026

Changes in this version

type AdminClient

+ Do func(req *http.Request) (*http.Response, error)

+ type HTTPTransport func() http.RoundTripper

type RunOpts

+ HTTPTransport http.RoundTripper

v1.4.0

Jan 28, 2026

v1.3.0

Oct 13, 2025

Changes in this version

+ type AdminClient interface

+ AwaitReady func(ctx context.Context, tickDuration time.Duration) error

+ Get func(ctx context.Context, path string) ([]byte, error)

+ IsReady func(ctx context.Context) error

+ NewListenerRequest func(ctx context.Context, name, method, path string, body io.Reader) (*http.Request, error)

+ Port func() int

+ type RunMiddlewareKey struct

+ type RunOpts struct

+ ConfigHome string

+ DataHome string

+ EnvoyErr io.Writer

+ EnvoyOut io.Writer

+ EnvoyPath string

+ EnvoyVersion string

+ EnvoyVersionsURL string

+ Out io.Writer

+ RunID string

+ RuntimeDir string

+ StartupHook StartupHook

+ StateHome string

+ type StartupHook func(ctx context.Context, adminClient AdminClient, runID string) error

v1.2.0

Jul 21, 2025

Changes in this version

+ func EnsureEnvoyVersion(ctx context.Context, o *globals.GlobalOpts) error

+ func EnsurePatchVersion(ctx context.Context, o *globals.GlobalOpts, v version.Version) (version.PatchVersion, error)

+ func InitializeGlobalOpts(o *globals.GlobalOpts, envoyVersionsURL, homeDir, platform string) error

+ func Run(ctx context.Context, o *globals.GlobalOpts, args []string) error