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, argsAndFlags []string) (stdout, stderr io.Reader, wait func() error, kill func())
• 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, 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.

type MaintenanceInfo

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

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