cli

README

CMD Package Documentation

In this package, the root command and its subcommands are defined for the CLI. This package, which is called from the main package, utilizes the pkg services to execute commands.

Documentation

Overview

Package cli provides functionality for the command-line interface of the application.

Index

• Variables
• func Config(ctx context.Context, logger *zap.Logger, cfg *config.Config, ...) *cobra.Command
• func Example(_ context.Context, logger *zap.Logger, _ *config.Config, _ ServiceFactory, ...) *cobra.Command
• func Mock(ctx context.Context, logger *zap.Logger, _ *config.Config, ...) *cobra.Command
• func Record(ctx context.Context, logger *zap.Logger, _ *config.Config, ...) *cobra.Command
• func Register(name string, f HookFunc)
• func Root(ctx context.Context, logger *zap.Logger, svcFactory ServiceFactory, ...) *cobra.Command
• func Test(ctx context.Context, logger *zap.Logger, cfg *config.Config, ...) *cobra.Command
• func Update(ctx context.Context, logger *zap.Logger, _ *config.Config, ...) *cobra.Command
• type CmdConfigurator
• type HookFunc
• type ServiceFactory

Variables

var Registered map[string]HookFunc

Registered holds the registered command hooks

Functions

func Config

func Config(ctx context.Context, logger *zap.Logger, cfg *config.Config, servicefactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

func Example

func Example(_ context.Context, logger *zap.Logger, _ *config.Config, _ ServiceFactory, _ CmdConfigurator) *cobra.Command

func Mock

func Mock(ctx context.Context, logger *zap.Logger, _ *config.Config, serviceFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

func Record

func Record(ctx context.Context, logger *zap.Logger, _ *config.Config, serviceFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

func Register

func Register(name string, f HookFunc)

func Root

func Root(ctx context.Context, logger *zap.Logger, svcFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

func Test

func Test(ctx context.Context, logger *zap.Logger, cfg *config.Config, serviceFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

func Update

func Update(ctx context.Context, logger *zap.Logger, _ *config.Config, serviceFactory ServiceFactory, cmdConfigurator CmdConfigurator) *cobra.Command

Update retrieves the command to tools Keploy

Types

type CmdConfigurator

type CmdConfigurator interface {
	AddFlags(cmd *cobra.Command) error
	ValidateFlags(ctx context.Context, cmd *cobra.Command) error
	Validate(ctx context.Context, cmd *cobra.Command) error
}

type HookFunc

type HookFunc func(context.Context, *zap.Logger, *config.Config, ServiceFactory, CmdConfigurator) *cobra.Command

type ServiceFactory

type ServiceFactory interface {
	GetService(ctx context.Context, cmd string) (interface{}, error)
}