engine

package

Go to main page

Versions in this module

v0

v0.7.8

Apr 26, 2026

Changes in this version

+ func LogsFlags(opts LogsOptions) []string

type ContainerInfo

+ Labels map[string]string

type Engine

+ func (e *Engine) ExecStreamSplit(ctx context.Context, args ...string) (io.ReadCloser, io.ReadCloser, error)

+ type LogsOptions struct

+ Follow bool

+ Since string

+ Tail string

+ Timestamps bool

+ Until string

type MockRuntime

+ func (m *MockRuntime) ExecStreamSplit(ctx context.Context, args ...string) (io.ReadCloser, io.ReadCloser, error)

type NerdctlRuntime

+ func (n *NerdctlRuntime) ExecStreamSplit(ctx context.Context, args ...string) (io.ReadCloser, io.ReadCloser, error)

type Runtime

+ ExecStreamSplit func(ctx context.Context, args ...string) (stdout io.ReadCloser, stderr io.ReadCloser, err error)

v0.7.7

Apr 24, 2026

v0.7.6

Apr 24, 2026

Changes in this version

type NetworkInfo

+ Labels map[string]string

type VolumeInfo

+ Labels map[string]string

v0.7.5

Apr 24, 2026

v0.7.4

Apr 24, 2026

v0.7.3

Apr 24, 2026

v0.7.2

Apr 24, 2026

v0.7.1

Apr 23, 2026

v0.7.0

Apr 23, 2026

Changes in this version

+ type ImagePullOpts struct

+ MaxConcurrent int

+ Platform string

+ Progress string

v0.6.5

Apr 23, 2026

v0.6.4

Apr 23, 2026

v0.6.3

Apr 23, 2026

v0.6.2

Apr 23, 2026

v0.6.1

Apr 12, 2026

v0.6.0

Apr 12, 2026

Changes in this version

+ func IsTerminal() bool — darwin/amd64, linux/amd64

v0.5.4

Apr 7, 2026

v0.5.3

Apr 7, 2026

v0.5.2

Apr 7, 2026

v0.5.1

Apr 7, 2026

v0.5.0

Apr 7, 2026

Changes in this version

type Engine

+ func (e *Engine) EnsureSystemRunning(ctx context.Context) error

+ type MockRuntime struct

+ BinaryPathFunc func() string

+ ContainerExecFunc func(ctx context.Context, nameOrID string, args []string, interactive bool) error

+ ContainerInspectFunc func(ctx context.Context, nameOrID string) ([]byte, error)

+ ContainerListFunc func(ctx context.Context, all bool) ([]ContainerInfo, error)

+ ContainerLogsFunc func(ctx context.Context, nameOrID string, follow bool) error

+ ContainerRemoveFunc func(ctx context.Context, nameOrID string, force bool) error

+ ContainerRunFunc func(ctx context.Context, args []string, interactive bool) error

+ ContainerStartFunc func(ctx context.Context, nameOrID string) error

+ ContainerStopFunc func(ctx context.Context, nameOrID string) error

+ ExecFunc func(ctx context.Context, args ...string) ([]byte, []byte, error)

+ ExecInteractiveFunc func(ctx context.Context, args ...string) error

+ ExecStreamFunc func(ctx context.Context, args ...string) (io.ReadCloser, error)

+ ImageBuildFunc func(ctx context.Context, args []string) error

+ ImageListFunc func(ctx context.Context) ([]ImageInfo, error)

+ ImagePullFunc func(ctx context.Context, image string) error

+ ImagePushFunc func(ctx context.Context, image string) error

+ ImageRemoveFunc func(ctx context.Context, image string) error

+ NetworkConnectFunc func(ctx context.Context, network, container string) error

+ NetworkCreateFunc func(ctx context.Context, name string) error

+ NetworkDisconnectFunc func(ctx context.Context, network, container string) error

+ NetworkInspectFunc func(ctx context.Context, name string) ([]byte, error)

+ NetworkListFunc func(ctx context.Context) ([]NetworkInfo, error)

+ NetworkRemoveFunc func(ctx context.Context, name string) error

+ ValidateFunc func() error

+ VolumeCreateFunc func(ctx context.Context, name string) error

+ VolumeInspectFunc func(ctx context.Context, name string) ([]byte, error)

+ VolumeListFunc func(ctx context.Context) ([]VolumeInfo, error)

+ VolumeRemoveFunc func(ctx context.Context, name string) error

+ func (m *MockRuntime) BinaryPath() string

+ func (m *MockRuntime) ContainerExec(ctx context.Context, nameOrID string, args []string, interactive bool) error

+ func (m *MockRuntime) ContainerInspect(ctx context.Context, nameOrID string) ([]byte, error)

+ func (m *MockRuntime) ContainerList(ctx context.Context, all bool) ([]ContainerInfo, error)

+ func (m *MockRuntime) ContainerLogs(ctx context.Context, nameOrID string, follow bool) error

+ func (m *MockRuntime) ContainerRemove(ctx context.Context, nameOrID string, force bool) error

+ func (m *MockRuntime) ContainerRun(ctx context.Context, args []string, interactive bool) error

+ func (m *MockRuntime) ContainerStart(ctx context.Context, nameOrID string) error

+ func (m *MockRuntime) ContainerStop(ctx context.Context, nameOrID string) error

+ func (m *MockRuntime) Exec(ctx context.Context, args ...string) ([]byte, []byte, error)

+ func (m *MockRuntime) ExecInteractive(ctx context.Context, args ...string) error

+ func (m *MockRuntime) ExecStream(ctx context.Context, args ...string) (io.ReadCloser, error)

+ func (m *MockRuntime) ImageBuild(ctx context.Context, args []string) error

+ func (m *MockRuntime) ImageList(ctx context.Context) ([]ImageInfo, error)

+ func (m *MockRuntime) ImagePull(ctx context.Context, image string) error

+ func (m *MockRuntime) ImagePush(ctx context.Context, image string) error

+ func (m *MockRuntime) ImageRemove(ctx context.Context, image string) error

+ func (m *MockRuntime) NetworkConnect(ctx context.Context, network, container string) error

+ func (m *MockRuntime) NetworkCreate(ctx context.Context, name string) error

+ func (m *MockRuntime) NetworkDisconnect(ctx context.Context, network, container string) error

+ func (m *MockRuntime) NetworkInspect(ctx context.Context, name string) ([]byte, error)

+ func (m *MockRuntime) NetworkList(ctx context.Context) ([]NetworkInfo, error)

+ func (m *MockRuntime) NetworkRemove(ctx context.Context, name string) error

+ func (m *MockRuntime) Validate() error

+ func (m *MockRuntime) VolumeCreate(ctx context.Context, name string) error

+ func (m *MockRuntime) VolumeInspect(ctx context.Context, name string) ([]byte, error)

+ func (m *MockRuntime) VolumeList(ctx context.Context) ([]VolumeInfo, error)

+ func (m *MockRuntime) VolumeRemove(ctx context.Context, name string) error

v0.4.3

Mar 30, 2026

v0.4.2

Mar 30, 2026

v0.4.1

Mar 24, 2026

v0.4.0

Mar 24, 2026

Changes in this version

type ContainerInfo

+ func ParseNerdctlContainerList(data []byte) ([]ContainerInfo, error)

type Engine

+ func (e *Engine) BinaryPath() string

type ImageInfo

+ func ParseNerdctlImageList(data []byte) ([]ImageInfo, error)

+ type NerdctlRuntime struct

+ Binary string

+ func NewNerdctl(binary string) *NerdctlRuntime

+ func (n *NerdctlRuntime) BinaryPath() string

+ func (n *NerdctlRuntime) ContainerExec(ctx context.Context, nameOrID string, args []string, interactive bool) error

+ func (n *NerdctlRuntime) ContainerInspect(ctx context.Context, nameOrID string) ([]byte, error)

+ func (n *NerdctlRuntime) ContainerList(ctx context.Context, all bool) ([]ContainerInfo, error)

+ func (n *NerdctlRuntime) ContainerLogs(ctx context.Context, nameOrID string, follow bool) error

+ func (n *NerdctlRuntime) ContainerRemove(ctx context.Context, nameOrID string, force bool) error

+ func (n *NerdctlRuntime) ContainerRun(ctx context.Context, args []string, interactive bool) error

+ func (n *NerdctlRuntime) ContainerStart(ctx context.Context, nameOrID string) error

+ func (n *NerdctlRuntime) ContainerStop(ctx context.Context, nameOrID string) error

+ func (n *NerdctlRuntime) Exec(ctx context.Context, args ...string) ([]byte, []byte, error)

+ func (n *NerdctlRuntime) ExecInteractive(ctx context.Context, args ...string) error

+ func (n *NerdctlRuntime) ExecStream(ctx context.Context, args ...string) (io.ReadCloser, error)

+ func (n *NerdctlRuntime) ImageBuild(ctx context.Context, args []string) error

+ func (n *NerdctlRuntime) ImageList(ctx context.Context) ([]ImageInfo, error)

+ func (n *NerdctlRuntime) ImagePull(ctx context.Context, image string) error

+ func (n *NerdctlRuntime) ImagePush(ctx context.Context, image string) error

+ func (n *NerdctlRuntime) ImageRemove(ctx context.Context, image string) error

+ func (n *NerdctlRuntime) NetworkConnect(ctx context.Context, network, container string) error

+ func (n *NerdctlRuntime) NetworkCreate(ctx context.Context, name string) error

+ func (n *NerdctlRuntime) NetworkDisconnect(ctx context.Context, network, container string) error

+ func (n *NerdctlRuntime) NetworkInspect(ctx context.Context, name string) ([]byte, error)

+ func (n *NerdctlRuntime) NetworkList(ctx context.Context) ([]NetworkInfo, error)

+ func (n *NerdctlRuntime) NetworkRemove(ctx context.Context, name string) error

+ func (n *NerdctlRuntime) Validate() error

+ func (n *NerdctlRuntime) VolumeCreate(ctx context.Context, name string) error

+ func (n *NerdctlRuntime) VolumeInspect(ctx context.Context, name string) ([]byte, error)

+ func (n *NerdctlRuntime) VolumeList(ctx context.Context) ([]VolumeInfo, error)

+ func (n *NerdctlRuntime) VolumeRemove(ctx context.Context, name string) error

type NetworkInfo

+ func ParseNerdctlNetworkList(data []byte) ([]NetworkInfo, error)

+ type Runtime interface

+ BinaryPath func() string

+ ContainerExec func(ctx context.Context, nameOrID string, args []string, interactive bool) error

+ ContainerInspect func(ctx context.Context, nameOrID string) ([]byte, error)

+ ContainerList func(ctx context.Context, all bool) ([]ContainerInfo, error)

+ ContainerLogs func(ctx context.Context, nameOrID string, follow bool) error

+ ContainerRemove func(ctx context.Context, nameOrID string, force bool) error

+ ContainerRun func(ctx context.Context, args []string, interactive bool) error

+ ContainerStart func(ctx context.Context, nameOrID string) error

+ ContainerStop func(ctx context.Context, nameOrID string) error

+ Exec func(ctx context.Context, args ...string) ([]byte, []byte, error)

+ ExecInteractive func(ctx context.Context, args ...string) error

+ ExecStream func(ctx context.Context, args ...string) (io.ReadCloser, error)

+ ImageBuild func(ctx context.Context, args []string) error

+ ImageList func(ctx context.Context) ([]ImageInfo, error)

+ ImagePull func(ctx context.Context, image string) error

+ ImagePush func(ctx context.Context, image string) error

+ ImageRemove func(ctx context.Context, image string) error

+ NetworkConnect func(ctx context.Context, network, container string) error

+ NetworkCreate func(ctx context.Context, name string) error

+ NetworkDisconnect func(ctx context.Context, network, container string) error

+ NetworkInspect func(ctx context.Context, name string) ([]byte, error)

+ NetworkList func(ctx context.Context) ([]NetworkInfo, error)

+ NetworkRemove func(ctx context.Context, name string) error

+ Validate func() error

+ VolumeCreate func(ctx context.Context, name string) error

+ VolumeInspect func(ctx context.Context, name string) ([]byte, error)

+ VolumeList func(ctx context.Context) ([]VolumeInfo, error)

+ VolumeRemove func(ctx context.Context, name string) error

+ func DetectRuntime(binaryOverride string) (Runtime, error)

type VolumeInfo

+ func ParseNerdctlVolumeList(data []byte) ([]VolumeInfo, error)

v0.3.0

Mar 21, 2026

v0.2.0

Mar 21, 2026

Changes in this version

+ type ContainerInfo struct

+ Command string

+ Created time.Time

+ ID string

+ IP string

+ Image string

+ Name string

+ Ports string

+ State string

+ Status string

+ type Engine struct

+ Binary string

+ func New(binary string) *Engine

+ func (e *Engine) ContainerExec(ctx context.Context, nameOrID string, args []string, interactive bool) error

+ func (e *Engine) ContainerInspect(ctx context.Context, nameOrID string) ([]byte, error)

+ func (e *Engine) ContainerList(ctx context.Context, all bool) ([]ContainerInfo, error)

+ func (e *Engine) ContainerLogs(ctx context.Context, nameOrID string, follow bool) error

+ func (e *Engine) ContainerRemove(ctx context.Context, nameOrID string, force bool) error

+ func (e *Engine) ContainerRun(ctx context.Context, args []string, interactive bool) error

+ func (e *Engine) ContainerStart(ctx context.Context, nameOrID string) error

+ func (e *Engine) ContainerStop(ctx context.Context, nameOrID string) error

+ func (e *Engine) Exec(ctx context.Context, args ...string) ([]byte, []byte, error)

+ func (e *Engine) ExecInteractive(ctx context.Context, args ...string) error

+ func (e *Engine) ExecStream(ctx context.Context, args ...string) (io.ReadCloser, error)

+ func (e *Engine) ImageBuild(ctx context.Context, args []string) error

+ func (e *Engine) ImageList(ctx context.Context) ([]ImageInfo, error)

+ func (e *Engine) ImagePull(ctx context.Context, image string) error

+ func (e *Engine) ImagePush(ctx context.Context, image string) error

+ func (e *Engine) ImageRemove(ctx context.Context, image string) error

+ func (e *Engine) NetworkConnect(ctx context.Context, network, container string) error

+ func (e *Engine) NetworkCreate(ctx context.Context, name string) error

+ func (e *Engine) NetworkDisconnect(ctx context.Context, network, container string) error

+ func (e *Engine) NetworkInspect(ctx context.Context, name string) ([]byte, error)

+ func (e *Engine) NetworkList(ctx context.Context) ([]NetworkInfo, error)

+ func (e *Engine) NetworkRemove(ctx context.Context, name string) error

+ func (e *Engine) Validate() error

+ func (e *Engine) VolumeCreate(ctx context.Context, name string) error

+ func (e *Engine) VolumeInspect(ctx context.Context, name string) ([]byte, error)

+ func (e *Engine) VolumeList(ctx context.Context) ([]VolumeInfo, error)

+ func (e *Engine) VolumeRemove(ctx context.Context, name string) error

+ type ImageInfo struct

+ Arch string

+ Created time.Time

+ Digest string

+ ID string

+ Name string

+ Size string

+ Tag string

+ type InspectData struct

+ Raw []byte

+ type NetworkInfo struct

+ Driver string

+ ID string

+ Name string

+ Scope string

+ type VolumeInfo struct

+ Created time.Time

+ Driver string

+ Mountpoint string

+ Name string

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