down

package

v0.2.0 Latest Latest Go to latest Published: Feb 20, 2026 License: MIT Imports: 3 Imported by: 0

Details

Package down is the package for the compose down options

This section is empty.

This section is empty.

func WithProfiles(profiles ...string) compose.SetComposeDownOption

WithProfiles is a function that sets the profiles for the compose down command

func WithRemoveImage(flag RemoveImageFlag) compose.SetComposeDownOption

WithRemoveImage is a function that sets the remove image flag

func WithRemoveOrphans() compose.SetComposeDownOption

WithRemoveOrphans is a function that sets the remove orphans flag

func WithRemoveVolumes() compose.SetComposeDownOption

WithRemoveVolumes is a function that sets the remove volumes flag

Remove named volumes declared in the "volumes" section of the Compose file and anonymous volumes attached to containers

func WithTimeout(timeout int) compose.SetComposeDownOption

WithTimeout is a function that sets the timeout flag in seconds

func WithWriter(writer io.Writer) compose.SetComposeDownOption

WithWriter sets the writer for the compose down command stdout and stderr

if writer is nil, it will use os.Stdout as a fallback

type RemoveImageFlag string

const (
	RemoveAll  RemoveImageFlag = "all"
	RemoveNone RemoveImageFlag = "none"
)