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

envite

package module

Go to main page

Versions in this module

v0

v0.0.13

Jun 7, 2026

v0.0.12

Nov 6, 2025

v0.0.11

Jun 20, 2025

v0.0.10

Aug 29, 2024

v0.0.9

Aug 24, 2024

v0.0.8

Jul 16, 2024

v0.0.7

Jul 10, 2024

v0.0.6

May 30, 2024

v0.0.5

Feb 25, 2024

v0.0.4

Feb 21, 2024

v0.0.3

Feb 17, 2024

Changes in this version

+ func DescribeAvailableModes() string

type GetStatusResponseComponent

+ Config map[string]any

type LogLevel

+ func (l LogLevel) String() string

v0.0.2

Dec 24, 2023

v0.0.1

Dec 19, 2023

Changes in this version

+ var ErrEmptyEnvID = errors.New("environment ID cannot be empty")

+ var ErrNilGraph = errors.New("environment component graph cannot be nil")

+ func Asset(name string) ([]byte, error)

+ func AssetDir(name string) ([]string, error)

+ func AssetFile() http.FileSystem

+ func AssetInfo(name string) (os.FileInfo, error)

+ func AssetNames() []string

+ func Execute(server *Server, executionMode ExecutionMode) error

+ func MustAsset(name string) []byte

+ func RestoreAsset(dir, name string) error

+ func RestoreAssets(dir, name string) error

+ type AnsiColor struct

+ func (a AnsiColor) Blue(s string) string

+ func (a AnsiColor) Cyan(s string) string

+ func (a AnsiColor) Green(s string) string

+ func (a AnsiColor) Magenta(s string) string

+ func (a AnsiColor) Red(s string) string

+ func (a AnsiColor) Yellow(s string) string

+ type Component interface

+ AttachEnvironment func(ctx context.Context, env *Environment, writer *Writer) error

+ Cleanup func(ctx context.Context) error

+ Config func() any

+ EnvVars func() map[string]string

+ ID func() string

+ Prepare func(ctx context.Context) error

+ Start func(ctx context.Context) error

+ Status func(ctx context.Context) (ComponentStatus, error)

+ Stop func(ctx context.Context) error

+ Type func() string

+ type ComponentGraph struct

+ func NewComponentGraph() *ComponentGraph

+ func (c *ComponentGraph) AddLayer(layerComponents ...Component) *ComponentGraph

+ type ComponentStatus string

+ const ComponentStatusFailed

+ const ComponentStatusFinished

+ const ComponentStatusRunning

+ const ComponentStatusStarting

+ const ComponentStatusStopped

+ type Environment struct

+ Logger Logger

+ func NewEnvironment(id string, componentGraph *ComponentGraph, options ...Option) (*Environment, error)

+ func (b *Environment) Apply(ctx context.Context, enabledComponentIDs []string) error

+ func (b *Environment) Cleanup(ctx context.Context) error

+ func (b *Environment) Components() []Component

+ func (b *Environment) Output() *Reader

+ func (b *Environment) StartAll(ctx context.Context) error

+ func (b *Environment) StartComponent(ctx context.Context, componentID string) error

+ func (b *Environment) Status(ctx context.Context) (GetStatusResponse, error)

+ func (b *Environment) StopAll(ctx context.Context) error

+ func (b *Environment) StopComponent(ctx context.Context, componentID string) error

+ type ErrInvalidComponentID struct

+ func (e ErrInvalidComponentID) Error() string

+ type ErrInvalidExecutionMode struct

+ func (e ErrInvalidExecutionMode) Error() string

+ type ExecutionMode string

+ const ExecutionModeDaemon

+ const ExecutionModeStart

+ const ExecutionModeStop

+ func ParseExecutionMode(value string) (ExecutionMode, error)

+ type GetStatusResponse struct

+ Components [][]GetStatusResponseComponent

+ ID string

+ type GetStatusResponseComponent struct

+ EnvVars map[string]string

+ ID string

+ Info any

+ Status ComponentStatus

+ Type string

+ type LogLevel uint8

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelFatal

+ const LogLevelInfo

+ const LogLevelTrace

+ type Logger func(level LogLevel, message string)

+ type Option func(*Environment)

+ func WithLogger(logger Logger) Option

+ type Reader struct

+ func (o *Reader) Chan() chan []byte

+ func (o *Reader) Close() error

+ type Server struct

+ func NewServer(port string, env *Environment) *Server

+ func (s *Server) Close() error

+ func (s *Server) Start() error

+ type Writer struct

+ Color AnsiColor

+ func (w *Writer) Write(message []byte)

+ func (w *Writer) WriteString(message string)

+ func (w *Writer) WriteStringWithTime(t time.Time, message string)

+ func (w *Writer) WriteWithTime(t time.Time, message []byte)