command

Documentation

Overview

Package command manages the basics of subcommands.

Index

• type BaseCommand
• type Command
• type RegisteredCommand

Types

type BaseCommand

type BaseCommand struct {
	Config *config.Config
}

BaseCommand represents a Vault subcommand. It contains the current config. Subcommands should be based off of this and implement Command.

type Command

type Command interface {
	Init(*config.Config, []string) error
	Run() error
}

Command represents a subcommand. It has an `Init` method and a `Run` method.

type RegisteredCommand

type RegisteredCommand struct {
	Name    string
	Command string
	Help    string
	Entry   Command
}

RegisteredCommand represents a command, plus additional data such as a short name, the text used to call the subcommand, and a help string.