devcontainer

Oct 28, 2026

Changes in this version

+ const LabelComposeInputsHash

Sep 16, 2026

Changes in this version

type EngineOptions

+ DisableHostPortPublishing bool

Aug 24, 2026

Changes in this version

type UpOptions

+ AdoptExisting bool

Jun 24, 2026

Changes in this version

+ type CheckpointOptions struct

+ ArchivePath string

+ StopAfter bool

+ TCPEstablished bool

type Engine

+ func (e *Engine) Checkpoint(ctx context.Context, ws *Workspace, opts CheckpointOptions) (runtime.CheckpointRef, error)

+ func (e *Engine) CheckpointProject(ctx context.Context, ws *Workspace, opts ProjectCheckpointOptions) (ProjectCheckpointRef, error)

+ func (e *Engine) Restore(ctx context.Context, opts RestoreOptions) (*Workspace, error)

+ func (e *Engine) RestoreProject(ctx context.Context, opts ProjectRestoreOptions) (*ProjectRestore, error)

+ type ProjectCheckpointOptions struct

+ ArchiveDir string

+ StopAfter bool

+ TCPEstablished bool

+ type ProjectCheckpointRef struct

+ ArchiveDir string

+ Project string

+ Services []ServiceCheckpoint

+ type ProjectRestore struct

+ Primary *Workspace

+ Project string

+ Services map[string]*runtime.Container

+ type ProjectRestoreOptions struct

+ ArchiveDir string

+ IgnoreVolumes bool

+ LocalEnv map[string]string

+ TCPEstablished bool

+ type RestoreOptions struct

+ ArchivePath string

+ IgnoreVolumes bool

+ LocalEnv map[string]string

+ Name string

+ TCPEstablished bool

+ type ServiceCheckpoint struct

+ Archive string

+ ContainerID string

+ Service string

+ Size int64

Jun 2, 2026

Changes in this version

+ var ErrComposeSourceUnsupported = errors.New("compose-source devcontainers are not supported by Engine.Build")

+ type BuildOptions struct

+ CacheFrom []string

+ ConfigPath string

+ Events chan<- events.Event

+ ImageName string

+ LocalEnv map[string]string

+ LocalWorkspaceFolder string

+ NoCache bool

+ Platform string

+ PullPolicy PullPolicy

+ type BuildResult struct

+ ImageID string

type Engine

+ func (e *Engine) Build(ctx context.Context, opts BuildOptions) (*BuildResult, error)

type ExecOptions

+ InitialTtySize runtime.TtySize

+ ResizeCh <-chan runtime.TtySize

May 18, 2026

Changes in this version

+ type ComposeBackend int

+ const ComposeBackendNative

+ const ComposeBackendShellout

type EngineOptions

+ ComposeBackend ComposeBackend

May 11, 2026

Changes in this version

+ const LabelConfigPath

+ const LabelDevcontainerID

+ const LabelEngine

+ const LabelLocalWorkspaceFolder

+ var ErrHostExecutorNotConfigured = errors.New("host executor not configured (set EngineOptions.HostExecutor)")

+ func IsLifecycleError(err error) bool

+ type AttachOptions struct

+ LocalEnv map[string]string

+ type DownOptions struct

+ Events chan<- events.Event

+ Remove bool

+ RemoveVolumes bool

+ type Engine struct

+ func New(opts EngineOptions) (*Engine, error)

+ func (e *Engine) Attach(ctx context.Context, id WorkspaceID) (*Workspace, error)

+ func (e *Engine) AttachWith(ctx context.Context, id WorkspaceID, opts AttachOptions) (*Workspace, error)

+ func (e *Engine) Down(ctx context.Context, ws *Workspace, opts DownOptions) error

+ func (e *Engine) Exec(ctx context.Context, ws *Workspace, opts ExecOptions) (ExecResult, error)

+ func (e *Engine) ExecByID(ctx context.Context, id WorkspaceID, opts ExecOptions) (ExecResult, error)

+ func (e *Engine) RunLifecycle(ctx context.Context, ws *Workspace, phase config.LifecyclePhase) error

+ func (e *Engine) Shutdown(ctx context.Context, ws *Workspace) error

+ func (e *Engine) Up(ctx context.Context, opts UpOptions) (*Workspace, error)

+ type EngineOptions struct

+ FeatureCacheDir string

+ FeatureDownloadHeaders map[string]string

+ FeatureHTTPSClient *http.Client

+ FeatureStore feature.Store

+ HostExecutor HostExecutor

+ OCIKeychain authn.Keychain

+ Runtime runtime.Runtime

+ StrictFeatureVersionMatch bool

+ type ExecOptions struct

+ Cmd []string

+ EmitEvents bool

+ Env map[string]string

+ Events chan<- events.Event

+ SkipUserEnvProbe bool

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ Tty bool

+ User string

+ WorkingDir string

+ type ExecResult struct

+ ExitCode int

+ Stderr string

+ Stdout string

+ type HostCommand struct

+ Env map[string]string

+ Exec []string

+ Shell string

+ WorkingDir string

+ type HostExecResult struct

+ ExitCode int

+ Stderr string

+ Stdout string

+ type HostExecutor interface

+ ExecHost func(ctx context.Context, cmd HostCommand) (HostExecResult, error)

+ type LifecycleError struct

+ Cause error

+ ExitCode int

+ Phase config.LifecyclePhase

+ Stderr string

+ Stdout string

+ func (e *LifecycleError) Error() string

+ func (e *LifecycleError) Unwrap() error

+ type PullPolicy string

+ const PullAlways

+ const PullIfNotPresent

+ const PullNever

+ type ResolveOptions struct

+ ConfigPath string

+ DevcontainerIDFunc func(localWorkspaceFolder, configPath string) string

+ LocalEnv map[string]string

+ LocalWorkspaceFolder string

+ type ResolvedConfig = config.ResolvedConfig

+ func Resolve(ctx context.Context, opts ResolveOptions) (*ResolvedConfig, error)

+ type Substituter struct

+ func (s *Substituter) Map(in map[string]string) (map[string]string, []config.Warning)

+ func (s *Substituter) Slice(in []string) ([]string, []config.Warning)

+ func (s *Substituter) String(in string) (string, []config.Warning)

+ type UpOptions struct

+ ConfigPath string

+ Events chan<- events.Event

+ ExtraContainerEnv map[string]string

+ ExtraMounts []runtime.MountSpec

+ LocalEnv map[string]string

+ LocalWorkspaceFolder string

+ PullPolicy PullPolicy

+ Recreate bool

+ RunInitializeCommand bool

+ RunSecretsCommand bool

+ SkipLifecycle bool

+ type Workspace struct

+ Config *config.ResolvedConfig

+ Container *runtime.ContainerDetails

+ ID WorkspaceID

+ type WorkspaceID string