app

Documentation

Index

• type Backup
  • func NewBackup(opts ...CommandOption) *Backup
  • func (b *Backup) Execute(args []string) error
• type Command
• type CommandOption
  • func WithConfig(config *config.Config) CommandOption

Types

type Backup

type Backup struct {
	Command
	ConfigPath string `required:"true" short:"c" long:"config" description:"The path to the YAML configuration required by hoard"`
}

Backup provides the logic to run Hoard's backup functionality.

func NewBackup

func NewBackup(opts ...CommandOption) *Backup

NewBackup instantiates an instance of the Backup command.

func (*Backup) Execute

func (b *Backup) Execute(args []string) error

Execute implements the go-flags Commander interface for the backup command, which uses the supplied configuration YAML to back up a set of directories to a storage backend.

type Command

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

Command provides common base logic for Hoard sub-commands to build upon.

type CommandOption

type CommandOption func(*Command)

CommandOption provides a way to configure a command.

func WithConfig

func WithConfig(config *config.Config) CommandOption

WithConfig sets the configuration on the command instance.