commands

Documentation

Index

• Constants
• Variables
• func Cleanup()
• func Debug(format string, args ...interface{})
• func Error(format string, args ...interface{})
• func Exit(format string, args ...interface{})
• func ExitWithError(err error)
• func FullError(err error)
• func LoggedError(err error, format string, args ...interface{})
• func NewCommand(name string, runFn func(*cobra.Command, []string)) *cobra.Command
• func Panic(err error, format string, args ...interface{})
• func PipeCommand(name string, args ...string) error
• func PipeMediaCommand(name string, args ...string) error
• func Print(format string, args ...interface{})
• func RegisterCommand(name string, runFn func(cmd *cobra.Command, args []string), ...)
• func Run()
• func TransferManifest() *transfer.Manifest
• type PruneProgress
• type PruneProgressChan
• type PruneProgressType

Constants

const (
	PruneProgressTypeLocal  = PruneProgressType(iota)
	PruneProgressTypeRetain = PruneProgressType(iota)
	PruneProgressTypeVerify = PruneProgressType(iota)
)

Variables

var (
	// API is a package-local instance of the API client for use within
	// various command implementations.
	API = api.NewClient(nil)

	Debugging    = false
	ErrorBuffer  = &bytes.Buffer{}
	ErrorWriter  = io.MultiWriter(os.Stderr, ErrorBuffer)
	OutputWriter = io.MultiWriter(os.Stdout, ErrorBuffer)
	ManPages     = make(map[string]string, 20)
)

Functions

func Cleanup

func Cleanup()

func Debug

func Debug(format string, args ...interface{})

Debug prints a formatted message if debugging is enabled. The formatted message also shows up in the panic log, if created.

func Error

func Error(format string, args ...interface{})

Error prints a formatted message to Stderr. It also gets printed to the panic log if one is created for this command.

func Exit

func Exit(format string, args ...interface{})

Exit prints a formatted message and exits.

func ExitWithError

func ExitWithError(err error)

ExitWithError either panics with a full stack trace for fatal errors, or simply prints the error message and exits immediately.

func FullError

func FullError(err error)

FullError prints either a full stack trace for fatal errors, or just the error message.

func LoggedError

func LoggedError(err error, format string, args ...interface{})

LoggedError prints the given message formatted with its arguments (if any) to Stderr. If an empty string is passed as the "format" arguemnt, only the standard error logging message will be printed, and the error's body will be omitted.

It also writes a stack trace for the error to a log file without exiting.

func NewCommand

func NewCommand(name string, runFn func(*cobra.Command, []string)) *cobra.Command

NewCommand creates a new 'git-lfs' sub command, given a command name and command run function.

Each command will initialize the local storage ('.git/lfs') directory when run, unless the PreRun hook is set to nil.

func Panic

func Panic(err error, format string, args ...interface{})

Panic prints a formatted message, and writes a stack trace for the error to a log file before exiting.

func PipeCommand

func PipeCommand(name string, args ...string) error

func PipeMediaCommand

func PipeMediaCommand(name string, args ...string) error

func Print

func Print(format string, args ...interface{})

Print prints a formatted message to Stdout. It also gets printed to the panic log if one is created for this command.

func RegisterCommand

func RegisterCommand(name string, runFn func(cmd *cobra.Command, args []string), fn func(cmd *cobra.Command))

RegisterCommand creates a direct 'git-lfs' subcommand, given a command name, a command run function, and an optional callback during the command initialization process.

The 'git-lfs' command initialization is deferred until the `commands.Run()` function is called. The fn callback is passed the output from NewCommand, and gives the caller the flexibility to customize the command by adding flags, tweaking command hooks, etc.

func Run

func Run()

Run initializes the 'git-lfs' command and runs it with the given stdin and command line args.

func TransferManifest

func TransferManifest() *transfer.Manifest

TransferManifest builds a transfer.Manifest from the commands package global cfg var.

Types

type PruneProgress

type PruneProgress struct {
	ProgressType PruneProgressType
	Count        int // Number of items done
}

Progress from a sub-task of prune

type PruneProgressChan

type PruneProgressChan chan PruneProgress

type PruneProgressType

type PruneProgressType int