cli

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 18, 2026 License: AGPL-3.0 Imports: 32 Imported by: 0

Documentation

Overview

Package cli implements the loadwave command line.

The same command set is compiled into the stock `loadwave` binary and into any binary a user builds with the Go SDK, which is what lets a test written in Go be its own coordinator, agent and worker with no extra tooling.

Index

Constants

View Source 
const (
	// ExitOK means the run completed and every threshold passed.
	ExitOK = 0
	// ExitError means the command could not do what was asked: a bad
	// configuration, an unreachable coordinator, no agents.
	ExitError = 1
	// ExitThresholdBreached means the run completed but a threshold failed.
	// Distinct from ExitError so a pipeline can tell "the tool broke" from
	// "the service under test was too slow".
	ExitThresholdBreached = 2
	// ExitInterrupted means the operator stopped the run.
	ExitInterrupted = 130
)

Exit codes. These are a contract with CI systems, so they are documented here and must not be reshuffled.

Variables

This section is empty.

Functions

func Execute 

func Execute(registry *loadwave.Registry) int

Execute runs the command line and returns a process exit code.

It returns rather than calling os.Exit so that deferred cleanup in callers still runs, and so that tests can exercise commands without taking the test binary down with them.

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.