cmd

Documentation

Overview

Package cmd implements the command-line interface of k6.

Index

• 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 ExecuteWithGlobalState

func ExecuteWithGlobalState(gs *state.GlobalState)

ExecuteWithGlobalState runs the root command with an existing GlobalState. It adds all child commands to the root command and it sets flags appropriately. It is called by main.main(). It only needs to happen once to the rootCmd.

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"`
	WebDashboard  null.Bool `json:"webDashboard" envconfig:"K6_WEB_DASHBOARD"`

	// NoArchiveUpload is an option that is only used when running in local-execution mode with the cloud run
	// command.
	//
	// Because the implementation of k6 cloud run calls the same code as the k6 run command under the hood, we
	// need to be able to pass down a configuration option that is only relevant to the cloud run command.
	NoArchiveUpload null.Bool `json:"noArchiveUpload" envconfig:"K6_NO_ARCHIVE_UPLOAD"`

	// 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