cli

Documentation

Overview

Package cli implements command-line commands for the Kopia.

Index

• type App
  • func NewApp() *App
  • func (c *App) Attach(app *kingpin.Application)
  • func (c *App) RunSubcommand(ctx context.Context, kpapp *kingpin.Application, argsAndFlags []string) (stdout, stderr io.Reader, wait func() error, kill func())
  • func (c *App) SetLoggerFactory(loggerForModule logging.LoggerFactory)
  • func (c *App) Stderr() io.Writer
• type MaintenanceInfo

Types

type App

type App struct {
	AdvancedCommands string
	// contains filtered or unexported fields
}

App contains per-invocation flags and state of Kopia CLI.

func NewApp

func NewApp() *App

NewApp creates a new instance of App.

func (*App) Attach

func (c *App) Attach(app *kingpin.Application)

Attach attaches the CLI parser to the application.

func (*App) RunSubcommand

func (c *App) RunSubcommand(ctx context.Context, kpapp *kingpin.Application, argsAndFlags []string) (stdout, stderr io.Reader, wait func() error, kill func())

RunSubcommand executes the subcommand asynchronously in current process with flags in an isolated CLI environment and returns standard output and standard error.

func (*App) SetLoggerFactory

func (c *App) SetLoggerFactory(loggerForModule logging.LoggerFactory)

SetLoggerFactory sets the logger factory to be used throughout the app.

func (*App) Stderr

func (c *App) Stderr() io.Writer

Stderr returns the stderr writer.

type MaintenanceInfo

type MaintenanceInfo struct {
	maintenance.Params
	maintenance.Schedule `json:"schedule"`
}

MaintenanceInfo is used to display the maintenance info in JSON format.