commonflags

Documentation

Index

• Constants
• func Bind(cmd *cobra.Command)
• func BindAPI(cmd *cobra.Command)
• func Init(cmd *cobra.Command)
• func InitAPI(cmd *cobra.Command)
• func InitSession(cmd *cobra.Command, name string)
• func InitWithoutRPC(cmd *cobra.Command)

Constants

const (
	TTL          = "ttl"
	TTLShorthand = ""
	TTLDefault   = 2
	TTLUsage     = "TTL value in request meta header"

	XHeadersKey       = "xhdr"
	XHeadersShorthand = "x"
	XHeadersUsage     = "Request X-Headers in form of Key=Value"
)

const (
	// ExpireAt is a flag for setting last epoch of an object or a token.
	ExpireAt = "expire-at"
	// Lifetime is a flag for setting the lifetime of an object or a token,
	// starting from the current epoch.
	Lifetime = "lifetime"
)

const (
	GenerateKey          = "generate-key"
	GenerateKeyShorthand = "g"
	GenerateKeyDefault   = false
	GenerateKeyUsage     = "Generate new private key"

	WalletPath          = "wallet"
	WalletPathShorthand = "w"
	WalletPathDefault   = ""
	WalletPathUsage     = "Path to the wallet or binary key"

	Account          = "address"
	AccountShorthand = ""
	AccountDefault   = ""
	AccountUsage     = "Address of wallet account"

	RPC          = "rpc-endpoint"
	RPCShorthand = "r"
	RPCDefault   = ""
	RPCUsage     = "Remote node address (as 'multiaddr' or '<host>:<port>')"

	Timeout          = "timeout"
	TimeoutShorthand = "t"
	TimeoutDefault   = 15 * time.Second
	TimeoutUsage     = "Timeout for an operation"

	Verbose          = "verbose"
	VerboseShorthand = "v"
	VerboseUsage     = "Verbose output"

	ForceFlag          = "force"
	ForceFlagShorthand = "f"

	CIDFlag      = "cid"
	CIDFlagUsage = "Container ID."

	OIDFlag      = "oid"
	OIDFlagUsage = "Object ID."

	TracingFlag      = "trace"
	TracingFlagUsage = "Generate trace ID and print it."

	AwaitFlag      = "await"
	AwaitFlagUsage = "Wait for the operation to complete"

	QuietFlag          = "quiet"
	QuietFlagShorthand = "q"
	QuietFlagUsage     = "Print nothing and exit with non-zero code on failure"
)

Common CLI flag keys, shorthands, default values and their usage descriptions.

const JSON = "json"

const SessionToken = "session"

Functions

func Bind

func Bind(cmd *cobra.Command)

Bind binds common command flags to the viper.

func BindAPI

func BindAPI(cmd *cobra.Command)

BindAPI binds API flags of storage node services to the viper.

func Init

func Init(cmd *cobra.Command)

Init adds common flags to the command: - GenerateKey, - WalletPath, - Account, - RPC, - Tracing, - Timeout.

func InitAPI

func InitAPI(cmd *cobra.Command)

InitAPI inits common flags for storage node services.

func InitSession

func InitSession(cmd *cobra.Command, name string)

InitSession registers SessionToken flag representing file path to the token of the session with the given name. Supports FrostFS-binary and JSON files.

func InitWithoutRPC

func InitWithoutRPC(cmd *cobra.Command)

InitWithoutRPC is similar to Init but doesn't create the RPC flag.