container

package

v0.7.0 Latest Latest Go to latest Published: May 6, 2026 License: Apache-2.0 Imports: 28 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/localstack/lstk

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Logs(ctx context.Context, rt runtime.Runtime, sink output.Sink, ...) error
func ResolveEmulatorLabel(ctx context.Context, client api.PlatformAPI, ...) (string, bool)
func Restart(ctx context.Context, rt runtime.Runtime, sink output.Sink, ...) error
func RunningEmulators(ctx context.Context, rt runtime.Runtime, containers []config.ContainerConfig) ([]config.ContainerConfig, error)
func Start(ctx context.Context, rt runtime.Runtime, sink output.Sink, opts StartOptions, ...) error
func Status(ctx context.Context, rt runtime.Runtime, containers []config.ContainerConfig, ...) error
func StillRunningMessage(running []config.ContainerConfig) string
func Stop(ctx context.Context, rt runtime.Runtime, sink output.Sink, ...) error
type StartOptions
type StopOptions

Constants ¶

View Source

const NoLicenseLabel = "LocalStack (No license)"

Variables ¶

This section is empty.

Functions ¶

func Logs ¶

func Logs(ctx context.Context, rt runtime.Runtime, sink output.Sink, containers []config.ContainerConfig, follow bool, verbose bool) error

func ResolveEmulatorLabel ¶ added in v0.5.7

func ResolveEmulatorLabel(ctx context.Context, client api.PlatformAPI, containers []config.ContainerConfig, token string, logger log.Logger) (string, bool)

ResolveEmulatorLabel tries to fetch the plan name from the license API to build a label like "LocalStack Ultimate". Falls back to NoLicenseLabel when the plan cannot be determined. The returned bool is true only when a real plan was resolved (i.e. the result is worth caching).

func Restart ¶ added in v0.5.8

func Restart(ctx context.Context, rt runtime.Runtime, sink output.Sink, stopOpts StopOptions, startOpts StartOptions, interactive bool) error

func RunningEmulators ¶ added in v0.7.0

func RunningEmulators(ctx context.Context, rt runtime.Runtime, containers []config.ContainerConfig) ([]config.ContainerConfig, error)

func Start ¶

func Start(ctx context.Context, rt runtime.Runtime, sink output.Sink, opts StartOptions, interactive bool) error

func Status ¶ added in v0.5.0

func Status(ctx context.Context, rt runtime.Runtime, containers []config.ContainerConfig, localStackHost string, clients map[config.EmulatorType]emulator.Client, sink output.Sink) error

func StillRunningMessage ¶ added in v0.7.0

func StillRunningMessage(running []config.ContainerConfig) string

func Stop ¶

func Stop(ctx context.Context, rt runtime.Runtime, sink output.Sink, containers []config.ContainerConfig, opts StopOptions) error

Types ¶

type StartOptions ¶ added in v0.4.0

type StartOptions struct {
	PlatformClient   api.PlatformAPI
	AuthToken        string
	ForceFileKeyring bool
	WebAppURL        string
	LocalStackHost   string
	Containers       []config.ContainerConfig
	Env              map[string]map[string]string
	Persist          bool
	Logger           log.Logger
	Telemetry        *telemetry.Client
}

StartOptions groups the user-provided options for starting an emulator.

type StopOptions ¶ added in v0.5.2

type StopOptions struct {
	Telemetry *telemetry.Client
}

StopOptions carries optional telemetry context for the stop command.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL