cli

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 17, 2026 License: BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CommandEvents = "events"
)

Variables

This section is empty.

Functions

func IsServiceArgSpec

func IsServiceArgSpec(spec yargs.ArgSpec) bool

func RemoteCommandInfos

func RemoteCommandInfos() map[string]CommandInfo

func RemoteCommandNames

func RemoteCommandNames() []string

func RemoteCommandRegistry

func RemoteCommandRegistry() yargs.Registry

func RemoteFlagSpecs

func RemoteFlagSpecs() map[string]map[string]FlagSpec

func RemoteGroupFlagSpecs

func RemoteGroupFlagSpecs() map[string]map[string]map[string]FlagSpec

func RemoteGroupInfos

func RemoteGroupInfos() map[string]GroupInfo

func RequireArgsAtLeast

func RequireArgsAtLeast(subcmd string, args []string, count int) error

Types

type CommandInfo

type CommandInfo struct {
	Name        string
	Description string
	Usage       string
	Examples    []string
	Hidden      bool
	Aliases     []string
	// ArgsSchema optionally defines positional args via `pos` tags.
	ArgsSchema any
}

type DockerPushArgs

type DockerPushArgs struct {
	Service ServiceName `pos:"0" help:"Service name"`
	Image   string      `pos:"1" help:"Local image ref"`
}

type EditFlags

type EditFlags struct {
	Config  bool
	TS      bool
	Restart bool
}

func ParseEdit

func ParseEdit(args []string) (EditFlags, []string, error)

type EnvShowFlags

type EnvShowFlags struct {
	Staged bool
}

func ParseEnvShow

func ParseEnvShow(args []string) (EnvShowFlags, []string, error)

type EventsFlags

type EventsFlags struct {
	All bool
}

func ParseEvents

func ParseEvents(args []string) (EventsFlags, []string, error)

type FlagSpec

type FlagSpec struct {
	ConsumesValue bool
}

type GroupInfo

type GroupInfo struct {
	Name        string
	Description string
	Commands    map[string]CommandInfo
	Hidden      bool
}

type InfoFlags

type InfoFlags struct {
	Format string
}

func ParseInfo

func ParseInfo(args []string) (InfoFlags, []string, error)

type LogsFlags

type LogsFlags struct {
	Follow bool
	Lines  int
}

func ParseLogs

func ParseLogs(args []string) (LogsFlags, []string, error)

type MountFlags

type MountFlags struct {
	Type string
	Opts string
	Deps []string
}

func ParseMount

func ParseMount(args []string) (MountFlags, []string, error)

type RemoveFlags

type RemoveFlags struct {
	Yes         bool
	CleanConfig bool
}

func ParseRemove

func ParseRemove(args []string) (RemoveFlags, []string, error)

type RunFlags

type RunFlags struct {
	Net           string
	TsVer         string
	TsExit        string
	TsTags        []string
	TsAuthKey     string
	MacvlanMac    string
	MacvlanVlan   int
	MacvlanParent string
	Restart       bool
	Pull          bool
	Publish       []string
	EnvFile       string
}

func ParseRun

func ParseRun(args []string) (RunFlags, []string, error)

type ServiceArgs

type ServiceArgs struct {
	Service ServiceName `pos:"0" help:"Service name"`
}

type ServiceName

type ServiceName string

type StageFlags

type StageFlags struct {
	Net           string
	TsVer         string
	TsExit        string
	TsTags        []string
	TsAuthKey     string
	MacvlanMac    string
	MacvlanVlan   int
	MacvlanParent string
	Restart       bool
	Pull          bool
	Publish       []string
}

func ParseStage

func ParseStage(args []string) (StageFlags, string, []string, error)

type StatusFlags

type StatusFlags struct {
	Format string
}

func ParseStatus

func ParseStatus(args []string) (StatusFlags, []string, error)

type VersionFlags

type VersionFlags struct {
	JSON bool
}

func ParseVersion

func ParseVersion(args []string) (VersionFlags, []string, error)

Jump to

Keyboard shortcuts

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