doc.go

/*
Command line utility bombardier is a fast cross-platform HTTP
benchmarking tool written in Go.

Installation with Go 1.17+:

	go install github.com/codesenberg/bombardier@latest

Installation with older versions of Go:

	go get -u github.com/codesenberg/bombardier

Usage:

	bombardier [<flags>] <url>

Flags:

	    --help                  Show context-sensitive help (also try --help-long
	                            and --help-man).
	    --version               Show application version.
	-c, --connections=125       Maximum number of concurrent connections
	-t, --timeout=2s            Socket/request timeout
	-l, --latencies             Print latency statistics
	-m, --method=GET            Request method
	-b, --body=""               Request body
	-f, --body-file=""          File to use as request body
	-s, --stream                Specify whether to stream body using chunked
	                            transfer encoding or to serve it from memory
	    --cert=""               Path to the client's TLS Certificate
	    --key=""                Path to the client's TLS Certificate Private Key
	-k, --insecure              Controls whether a client verifies the server's
	                            certificate chain and host name
	-H, --header="K: V" ...     HTTP headers to use(can be repeated)
	-n, --requests=[pos. int.]  Number of requests
	-d, --duration=10s          Duration of test
	-r, --rate=[pos. int.]      Rate limit in requests per second
	    --fasthttp              Use fasthttp client
	    --http1                 Use net/http client with forced HTTP/1.x
	    --http2                 Use net/http client with enabled HTTP/2.0
	-p, --print=<spec>          Specifies what to output. Comma-separated list of
	                            values 'intro' (short: 'i'), 'progress' (short:
	                            'p'), 'result' (short: 'r'). Examples:

	                              * i,p,r (prints everything)
	                              * intro,result (intro & result)
	                              * r (result only)
	                              * result (same as above)
	-q, --no-print              Don't output anything
	-o, --format=<spec>         Which format to use to output the result. <spec>
	                            is either a name (or its shorthand) of some format
	                            understood by bombardier or a path to the
	                            user-defined template, which uses Go's
	                            text/template syntax, prefixed with 'path:' string
	                            (without single quotes), i.e.
	                            "path:/some/path/to/your.template" or
	                            "path:C:\some\path\to\your.template" in case of
	                            Windows. Formats understood by bombardier are:

	                              * plain-text (short: pt)
	                              * json (short: j)

Args:

	<url>  Target's URL

For detailed documentation on user-defined templates see
documentation for package github.com/codesenberg/bombardier/template.
Link (GoDoc):
https://godoc.org/github.com/codesenberg/bombardier/template
*/
package main