Running Ginkgo

How to drive the suite once it's wired up (ginkgo:setup). For a production CI configuration, see ginkgo:ci. Docs: https://onsi.github.io/ginkgo/#ginkgo-cli-overview.

The CLI surface

ginkgo is the recommended runner, you can run suites with go test, but only the CLI does parallelism and profile aggregation, and a few go test flags (e.g. -count=N, use --repeat=N) are unsupported. ginkgo is shorthand for ginkgo run; it passes through nearly all go test/go build flags.

ginkgo                                  # run the suite in the current directory
ginkgo path/to/suite path/to/other      # run several named suites
ginkgo -r                               # recurse the tree, run every suite found (== ginkgo ./...)
ginkgo -p                               # run in parallel (→ ginkgo:parallelism)
ginkgo -v --dry-run                     # build the tree and print what WOULD run, without running
ginkgo <GINKGO-FLAGS> <PACKAGES> -- <PASS-THROUGHS>   # the full grammar

Ginkgo flags must come before the package list; suite-bound args go after --. Subcommands:

Command	Does
ginkgo build path/...	Precompile each suite to a package.test binary (accepts a subset of run flags, compile-time only)
ginkgo watch -r -p	Re-run suites when they or their dependencies change (-depth tunes dependency monitoring)
ginkgo bootstrap / ginkgo generate <subject>	Scaffold a suite / a spec file (→ ginkgo:setup); both take --template/--template-data
ginkgo outline <file>	Static (AST-parsed) spec outline as csv/indent/json, no compile needed
ginkgo unfocus	Strip all programmatic F-focus from the tree (→ ginkgo:filtering)
ginkgo labels	List the Labels used in a suite (naive parse)
ginkgo version	Print the CLI version