cmd

Documentation

Overview

Package cmd implements console commands

Index

• Constants
• func CleanupContext()
• func GetContext() *ctx.AptlyContext
• func GetStringOrFileContent(value string) (string, error)
• func InitContext(flags *flag.FlagSet) error
• func ListPackagesRefList(reflist *deb.PackageRefList, collectionFactory *deb.CollectionFactory) (err error)
• func LookupOption(defaultValue bool, flags *flag.FlagSet, name string) (result bool)
• func PrintPackageList(result *deb.PackageList, format, prefix string) error
• func RootCommand() *commander.Command
• func Run(cmd *commander.Command, cmdArgs []string, initContext bool) (returnCode int)
• func ShutdownContext()
• type StringOrFileFlag
  • func AddStringOrFileFlag(flagSet *flag.FlagSet, name string, value string, usage string) *StringOrFileFlag
  • func (s *StringOrFileFlag) Get() any
  • func (s *StringOrFileFlag) Set(value string) error
  • func (s *StringOrFileFlag) String() string

Constants

const (
	Yes = "yes"
	No  = "no"
)

Various command flags/UI things

Functions

func CleanupContext

func CleanupContext()

CleanupContext does partial shutdown of context

func GetContext

func GetContext() *ctx.AptlyContext

GetContext gives access to the context

func GetStringOrFileContent

func GetStringOrFileContent(value string) (string, error)

func InitContext

func InitContext(flags *flag.FlagSet) error

InitContext initializes context with default settings

func ListPackagesRefList

func ListPackagesRefList(reflist *deb.PackageRefList, collectionFactory *deb.CollectionFactory) (err error)

ListPackagesRefList shows list of packages in PackageRefList

func LookupOption

func LookupOption(defaultValue bool, flags *flag.FlagSet, name string) (result bool)

LookupOption checks boolean flag with default (usually config) and command-line setting

func PrintPackageList

func PrintPackageList(result *deb.PackageList, format, prefix string) error

PrintPackageList shows package list with specified format or default representation

func RootCommand

func RootCommand() *commander.Command

RootCommand creates root command in command tree

func Run

func Run(cmd *commander.Command, cmdArgs []string, initContext bool) (returnCode int)

Run runs single command starting from root cmd with args, optionally initializing context

func ShutdownContext

func ShutdownContext()

ShutdownContext shuts context down

Types

type StringOrFileFlag

type StringOrFileFlag struct {
	// contains filtered or unexported fields
}

StringOrFileFlag is a custom flag type that can handle both string input and file input. If the input starts with '@', it is treated as a filename and the contents are read from the file. If the input is '@-', the contents are read from stdin.

func AddStringOrFileFlag

func AddStringOrFileFlag(flagSet *flag.FlagSet, name string, value string, usage string) *StringOrFileFlag

func (*StringOrFileFlag) Get

func (s *StringOrFileFlag) Get() any

func (*StringOrFileFlag) Set

func (s *StringOrFileFlag) Set(value string) error

func (*StringOrFileFlag) String

func (s *StringOrFileFlag) String() string