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

config

package

Go to main page

Versions in this module

v0

v0.4.0

Jun 24, 2026

Changes in this version

type ResolvedConfig

+ Entrypoints []string

v0.3.0

Jun 2, 2026

v0.2.0

May 18, 2026

v0.1.4

May 13, 2026

v0.1.3

May 13, 2026

v0.1.2

May 12, 2026

v0.1.1

May 11, 2026

Changes in this version

+ func BoolOr(p *bool, def bool) bool

+ func DecodeMounts(data json.RawMessage) ([]Mount, []Warning, error)

+ func DevcontainerID(localWorkspaceFolder, configPath string) string

+ func MergeMetadata(cfg *ResolvedConfig, layers []FeatureMetadata)

+ func SortedKeys[V any](m map[string]V) []string

+ type BindOptions struct

+ CreateHostPath bool

+ Propagation string

+ type BuildSource struct

+ Args map[string]string

+ CacheFrom []string

+ Context string

+ Dockerfile string

+ Options map[string]string

+ Target string

+ func (*BuildSource) Kind() SourceKind

+ type Command struct

+ Exec []string

+ Shell string

+ func (c Command) IsEmpty() bool

+ type ComposeSource struct

+ Files []string

+ RunServices []string

+ Service string

+ func (*ComposeSource) Kind() SourceKind

+ type ConfigInvalidError struct

+ Message string

+ Path string

+ func (e *ConfigInvalidError) Error() string

+ type ConfigParseError struct

+ Err error

+ Path string

+ func (e *ConfigParseError) Error() string

+ func (e *ConfigParseError) Unwrap() error

+ type FeatureMetadata struct

+ CapAdd []string

+ ContainerEnv map[string]string

+ ContainerUser string

+ Customizations map[string]json.RawMessage

+ DependsOn map[string]map[string]any

+ Description string

+ DocumentationURL string

+ Entrypoint string

+ HostRequirements *HostRequirements

+ ID string

+ Init *bool

+ InstallsAfter []string

+ LicenseURL string

+ Mounts []Mount

+ Name string

+ OnCreateCommand LifecycleCommand

+ Options map[string]FeatureOption

+ OverrideCommand *bool

+ PostAttachCommand LifecycleCommand

+ PostCreateCommand LifecycleCommand

+ PostStartCommand LifecycleCommand

+ Privileged *bool

+ RemoteEnv map[string]string

+ RemoteUser string

+ SecurityOpt []string

+ ShutdownAction ShutdownAction

+ UpdateContentCommand LifecycleCommand

+ UpdateRemoteUserUID *bool

+ UserEnvProbe UserEnvProbe

+ Version string

+ WaitFor LifecyclePhase

+ type FeatureOption struct

+ Default any

+ Description string

+ Enum []any

+ Proposals []any

+ Type string

+ type FeatureSourceKind string

+ const FeatureSourceHTTPS

+ const FeatureSourceLocal

+ const FeatureSourceOCI

+ type GPURequirement struct

+ Optional bool

+ type HostRequirements struct

+ CPUs int

+ GPU *GPURequirement

+ Memory string

+ Storage string

+ type ImageSource struct

+ Image string

+ func (*ImageSource) Kind() SourceKind

+ type LifecycleCommand struct

+ Parallel map[string]Command

+ Single *Command

+ func DecodeLifecycleCommand(data json.RawMessage) (LifecycleCommand, error)

+ func (l LifecycleCommand) IsEmpty() bool

+ type LifecycleCommands struct

+ Initialize []LifecycleCommand

+ OnCreate []LifecycleCommand

+ PostAttach []LifecycleCommand

+ PostCreate []LifecycleCommand

+ PostStart []LifecycleCommand

+ UpdateContent []LifecycleCommand

+ type LifecyclePhase string

+ const LifecycleInitialize

+ const LifecycleOnCreate

+ const LifecyclePostAttach

+ const LifecyclePostCreate

+ const LifecyclePostStart

+ const LifecycleUpdateContent

+ type Mount struct

+ BindOptions *BindOptions

+ ReadOnly bool

+ Source string

+ Target string

+ TmpfsOptions *TmpfsOptions

+ Type MountType

+ VolumeOptions *VolumeOptions

+ type MountType string

+ const MountBind

+ const MountTmpfs

+ const MountVolume

+ type PortAttributes struct

+ ElevateIfNeeded bool

+ Label string

+ OnAutoForward string

+ Protocol string

+ RequireLocalPort bool

+ type PortSpec struct

+ Container int

+ Host int

+ Label string

+ type ResolveInput struct

+ ConfigPath string

+ DevcontainerID string

+ LocalEnv map[string]string

+ LocalWorkspaceFolder string

+ type ResolvedConfig struct

+ CapAdd []string

+ ContainerEnv map[string]string

+ ContainerUser string

+ ContainerWorkspaceFolder string

+ Customizations map[string]json.RawMessage

+ DevcontainerID string

+ Features []ResolvedFeature

+ ForwardPorts []PortSpec

+ HostRequirements *HostRequirements

+ Init *bool

+ Lifecycle LifecycleCommands

+ LocalWorkspaceFolder string

+ Mounts []Mount

+ Name string

+ OtherPortsAttributes *PortAttributes

+ OverrideCommand *bool

+ PortsAttributes map[string]PortAttributes

+ Privileged *bool

+ RemoteEnv map[string]string

+ RemoteUser string

+ RunArgs []string

+ SecretsCommand LifecycleCommand

+ SecurityOpt []string

+ ShutdownAction ShutdownAction

+ Source Source

+ UpdateRemoteUserUID *bool

+ UserEnvProbe UserEnvProbe

+ WaitFor LifecyclePhase

+ Warnings []Warning

+ WorkspaceMount *Mount

+ func ResolveBytes(src []byte, input ResolveInput) (*ResolvedConfig, error)

+ func (c *ResolvedConfig) Finalize()

+ type ResolvedFeature struct

+ AlreadyInstalled bool

+ Dir string

+ Metadata FeatureMetadata

+ Options map[string]any

+ Ref string

+ ResolvedRef string

+ SourceKind FeatureSourceKind

+ type ShutdownAction string

+ const ShutdownNone

+ const ShutdownStop

+ const ShutdownStopCompose

+ const ShutdownStopContainer

+ type Source interface

+ Kind func() SourceKind

+ type SourceKind string

+ const SourceBuild

+ const SourceCompose

+ const SourceImage

+ type SubstitutionContext struct

+ ContainerEnv map[string]string

+ ContainerWorkspaceFolder string

+ DevcontainerID string

+ LocalEnv map[string]string

+ LocalWorkspaceFolder string

+ type TmpfsOptions struct

+ Mode uint32

+ SizeBytes int64

+ type UserEnvProbe string

+ const UserEnvProbeInteractiveShell

+ const UserEnvProbeLoginInteractive

+ const UserEnvProbeLoginShell

+ const UserEnvProbeNone

+ type VolumeDriverConfig struct

+ Name string

+ Options map[string]string

+ type VolumeOptions struct

+ DriverConfig *VolumeDriverConfig

+ Labels map[string]string

+ NoCopy bool

+ type Warning struct

+ Code WarningCode

+ Message string

+ Path string

+ Source string

+ func ResolveString(s string, ctx SubstitutionContext) (string, []Warning)

+ type WarningCode string

+ const WarnComposePortsIgnored

+ const WarnDeepFeatureChain

+ const WarnDeprecatedKey

+ const WarnUIDReconcileSkipped

+ const WarnUnknownFeatureOption

+ const WarnUnknownField

+ const WarnUnknownVariable

+ const WarnUnresolvedContainerEnv

+ const WarnUnresolvedLocalEnv

+ const WarnUnsupportedFeatureField

v0.1.0

May 11, 2026