package compose

import "github.com/docker/compose/v2/cmd/compose"

Index ¶

• Constants
• Variables
• func Adapt(fn Command) func(cmd *cobra.Command, args []string) error
• func AdaptCmd(fn CobraCommand) func(cmd *cobra.Command, args []string) error
• func DisplayablePorts(c api.ContainerSummary) string
• func RootCommand(backend api.Service) *cobra.Command
• func RunningAsStandalone() bool
• type CobraCommand
• type Command
• type ProjectFunc
• type ProjectServicesFunc

Constants ¶

const PluginName = "compose"

PluginName is the name of the plugin

Variables ¶

var Warning string

Warning is a global warning to be displayed to user on command failure

Functions ¶

func Adapt ¶

func Adapt(fn Command) func(cmd *cobra.Command, args []string) error

Adapt a Command func to cobra library

func AdaptCmd ¶

func AdaptCmd(fn CobraCommand) func(cmd *cobra.Command, args []string) error

AdaptCmd adapt a CobraCommand func to cobra library

func DisplayablePorts ¶

func DisplayablePorts(c api.ContainerSummary) string

DisplayablePorts is copy pasted from https://github.com/docker/cli/pull/581/files

func RootCommand ¶

func RootCommand(backend api.Service) *cobra.Command

RootCommand returns the compose command with its child commands

func RunningAsStandalone ¶

func RunningAsStandalone() bool

RunningAsStandalone detects when running as a standalone program

Types ¶

type CobraCommand ¶

type CobraCommand func(context.Context, *cobra.Command, []string) error

CobraCommand defines a cobra command function

type Command ¶

type Command func(context.Context, []string) error

Command defines a compose CLI command as a func with args

type ProjectFunc ¶

type ProjectFunc func(ctx context.Context, project *types.Project) error

ProjectFunc does stuff within a types.Project

type ProjectServicesFunc ¶

type ProjectServicesFunc func(ctx context.Context, project *types.Project, services []string) error

ProjectServicesFunc does stuff within a types.Project and a selection of services

Source Files ¶

build.go completion.go compose.go convert.go cp.go create.go down.go events.go exec.go images.go kill.go list.go logs.go pause.go port.go ps.go pull.go push.go remove.go restart.go run.go start.go stop.go top.go up.go version.go