compose

package

v2.0.0-...-9cab126 Latest Latest Go to latest Published: Apr 1, 2023 License: Apache-2.0 Imports: 45 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/telecomposeio/compose

Documentation ¶

Index ¶

Constants
func Adapt(fn Command) func(cmd *cobra.Command, args []string) error
func AdaptCmd(fn CobraCommand) func(cmd *cobra.Command, args []string) error
func RootCommand(streams command.Cli, backend api.Service) *cobra.Command
func RunningAsStandalone() bool
type CobraCommand
type Command
type ProjectFunc
type ProjectOptions
type ProjectServicesFunc

Constants ¶

View Source

const PluginName = "compose"

PluginName is the name of the plugin

Variables ¶

This section is empty.

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 RootCommand ¶

func RootCommand(streams command.Cli, 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 ProjectOptions ¶

type ProjectOptions struct {
	ProjectName   string
	Profiles      []string
	ConfigPaths   []string
	WorkDir       string
	ProjectDir    string
	EnvFiles      []string
	Compatibility bool
}

func (*ProjectOptions) ToProject ¶

func (o *ProjectOptions) ToProject(services []string, po ...cli.ProjectOptionsFn) (*types.Project, error)

func (*ProjectOptions) WithProject ¶

func (o *ProjectOptions) WithProject(fn ProjectFunc) func(cmd *cobra.Command, args []string) error

WithProject creates a cobra run command from a ProjectFunc based on configured project options and selected services

func (*ProjectOptions) WithServices ¶

func (o *ProjectOptions) WithServices(fn ProjectServicesFunc) func(cmd *cobra.Command, args []string) error

WithServices creates a cobra run command from a ProjectFunc based on configured project options and selected services

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 ¶

View all Source files

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