cmd

Documentation

Index

• Constants
• func Init(ctx *cli.Context, basePath, owner, password, backendName, ipfsPath string, ...) error
• func RunCmdline(args []string) int
• func TranslateHelp(cmds []cli.Command) []cli.Command
• type ExitCode
  • func (err ExitCode) Error() string

Constants

const (
	// Success is the same as EXIT_SUCCESS in C
	Success = iota

	// BadArgs passed to cli; not our fault.
	BadArgs

	// BadPassword passed to prompt or switch; not our fault.
	BadPassword

	// DaemonNotResponding means the daemon does not respond in timely fashion.
	// Probably our fault.
	DaemonNotResponding

	// UnknownError is an uncategorized error, probably our fault.
	UnknownError
)

Functions

func Init

func Init(ctx *cli.Context, basePath, owner, password, backendName, ipfsPath string, port int) error

Init creates a new brig repository at `basePath` with `owner`. `password` is used to encrypt it and `backendName` tells `brig` what backend to initialize. The port is the port of the brig daemon.

func RunCmdline

func RunCmdline(args []string) int

RunCmdline starts a brig commandline tool.

func TranslateHelp

func TranslateHelp(cmds []cli.Command) []cli.Command

TranslateHelp fills in the usage and description for each command. This is separated from the command definition to make things more readable, and separate logic from the (lengthy) documentation.

Types

type ExitCode

type ExitCode struct {
	Code    int
	Message string
}

ExitCode is an error that maps the error interface to a specific error message and a unix exit code

func (ExitCode) Error

func (err ExitCode) Error() string