cmd

Documentation

Overview

Package cmd implements the command-line interface of k6.

Index

• func Execute()
• func ExecuteWithGlobalState(gs *state.GlobalState)
• type Config
  • func (c Config) Apply(cfg Config) Config
  • func (c Config) Validate() []error
• type RawFormatter
  • func (f RawFormatter) Format(entry *logrus.Entry) ([]byte, error)

Functions

func Execute

func Execute()

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func ExecuteWithGlobalState

func ExecuteWithGlobalState(gs *state.GlobalState)

ExecuteWithGlobalState runs the root command with an existing GlobalState. This is needed by integration tests, and we don't want to modify the Execute() signature to avoid breaking k6 extensions.

Types

type Config

type Config struct {
	lib.Options

	Out           []string  `json:"out" envconfig:"K6_OUT"`
	Linger        null.Bool `json:"linger" envconfig:"K6_LINGER"`
	NoUsageReport null.Bool `json:"noUsageReport" envconfig:"K6_NO_USAGE_REPORT"`

	// TODO: deprecate
	Collectors map[string]json.RawMessage `json:"collectors"`
}

Config ...

func (Config) Apply

func (c Config) Apply(cfg Config) Config

Apply the provided config on top of the current one, returning a new one. The provided config has priority.

func (Config) Validate

func (c Config) Validate() []error

Validate checks if all of the specified options make sense

type RawFormatter

type RawFormatter struct{}

RawFormatter it does nothing with the message just prints it

func (RawFormatter) Format

func (f RawFormatter) Format(entry *logrus.Entry) ([]byte, error)

Format renders a single log entry