subcommands

Documentation

Index

• func SubCommand(args []string, scmds []Runner) error
• type InstallCommand
  • func NewInstallCommand(tools utils.Tools, cp utils.Copier, config utils.Config) *InstallCommand
  • func (ic *InstallCommand) Init(args []string) error
  • func (ic *InstallCommand) Name() string
  • func (ic *InstallCommand) Run() error
• type RunCommand
  • func NewRunCommand(tools utils.Tools, config utils.Config) *RunCommand
  • func (rc *RunCommand) Init(args []string) error
  • func (rc *RunCommand) Name() string
  • func (rc *RunCommand) Run() error
• type Runner
• type UninstallCommand
  • func NewUninstallCommand(tools utils.Tools, config utils.Config) *UninstallCommand
  • func (uc *UninstallCommand) Init(args []string) error
  • func (uc *UninstallCommand) Name() string
  • func (uc *UninstallCommand) Run() error
• type UpdateCommand
  • func NewUpdateCommand(tools utils.Tools, config utils.Config) *UpdateCommand
  • func (uc *UpdateCommand) Init(args []string) error
  • func (uc *UpdateCommand) Name() string
  • func (uc *UpdateCommand) Run() error
• type UpgradeCommand
  • func NewUpgradeCommand(tools utils.Tools, cp utils.Copier, config utils.Config) *UpgradeCommand
  • func (ic *UpgradeCommand) Init(args []string) error
  • func (ic *UpgradeCommand) Name() string
  • func (ic *UpgradeCommand) Run() error
• type VersionCommand
  • func NewVersionCommand(tools utils.Tools) *VersionCommand
  • func (vc *VersionCommand) Init(args []string) error
  • func (vc *VersionCommand) Name() string
  • func (vc *VersionCommand) Run() error

Functions

func SubCommand

func SubCommand(args []string, scmds []Runner) error

SubCommand - Helper function that handles setting up and running subcommands

Types

type InstallCommand

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

Install Sub-Command Object

func NewInstallCommand

func NewInstallCommand(tools utils.Tools, cp utils.Copier, config utils.Config) *InstallCommand

Instantiation method for a new InstallCommand

func (*InstallCommand) Init

func (ic *InstallCommand) Init(args []string) error

Init - Parses and Populates values of the Install subcommand

func (*InstallCommand) Name

func (ic *InstallCommand) Name() string

Name - Gets the name of the Sub-Command

func (*InstallCommand) Run

func (ic *InstallCommand) Run() error

Run - Runs the install subcommand

type RunCommand

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

Run Sub-Command Object

func NewRunCommand

func NewRunCommand(tools utils.Tools, config utils.Config) *RunCommand

Instantiation method for a new RunCommand

func (*RunCommand) Init

func (rc *RunCommand) Init(args []string) error

Init - Parses and Populates values of the Run subcommand

func (*RunCommand) Name

func (rc *RunCommand) Name() string

Name - Gets the name of the Sub-Command

func (*RunCommand) Run

func (rc *RunCommand) Run() error

Run - Runs the Run subcommand

type Runner

type Runner interface {
	Init(args []string) error
	Run() error
	Name() string
}

Runner - Interface to enable easy interactions with the different subcommand objects

type UninstallCommand

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

Uninstall Sub-Command Object

func NewUninstallCommand

func NewUninstallCommand(tools utils.Tools, config utils.Config) *UninstallCommand

Instantiation method for a new UninstallCommand

func (*UninstallCommand) Init

func (uc *UninstallCommand) Init(args []string) error

Init - Parses and Populates values of the Uninstall subcommand

func (*UninstallCommand) Name

func (uc *UninstallCommand) Name() string

Name - Gets the name of the Sub-Command

func (*UninstallCommand) Run

func (uc *UninstallCommand) Run() error

Uninstall - Uninstalls the Uninstall subcommand

type UpdateCommand

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

func NewUpdateCommand

func NewUpdateCommand(tools utils.Tools, config utils.Config) *UpdateCommand

Instantiation method for a new UpdateCommand

func (*UpdateCommand) Init

func (uc *UpdateCommand) Init(args []string) error

Initialize the command, for this particular subcommand we should just do nothing

func (*UpdateCommand) Name

func (uc *UpdateCommand) Name() string

Name - Gets the name of the Sub-Command

func (*UpdateCommand) Run

func (uc *UpdateCommand) Run() error

Run the command, this command should fetch the pim config for either the specified package or all currently installed packages

type UpgradeCommand

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

Upgrade Sub-Command Object

func NewUpgradeCommand

func NewUpgradeCommand(tools utils.Tools, cp utils.Copier, config utils.Config) *UpgradeCommand

Instantiation method for a new UpgradeCommand

func (*UpgradeCommand) Init

func (ic *UpgradeCommand) Init(args []string) error

Init - Parses and Populates values of the Upgrade subcommand

func (*UpgradeCommand) Name

func (ic *UpgradeCommand) Name() string

Name - Gets the name of the Sub-Command

func (*UpgradeCommand) Run

func (ic *UpgradeCommand) Run() error

Run - Runs the Upgrade subcommand

type VersionCommand

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

func NewVersionCommand

func NewVersionCommand(tools utils.Tools) *VersionCommand

Instantiation method for a new VersionCommand

func (*VersionCommand) Init

func (vc *VersionCommand) Init(args []string) error

Initialize the command, for this particular subcommand we should just do nothing

func (*VersionCommand) Name

func (vc *VersionCommand) Name() string

Name - Gets the name of the Sub-Command

func (*VersionCommand) Run

func (vc *VersionCommand) Run() error

Run the command, this particular command should be a simple print of the value of the version variable