Captain CLI Configuration
The Captain CLI is a tool that helps you make your test suite more reliable and your
engineers more productive. It primarily supports configuration via a config file
(.captain/config.yaml
) and can be run in Cloud mode, enabling
usage of the Captain Cloud Dashboard, or in OSS mode. When run in OSS mode, the CLI
functionality is enabled by maintaining additional configuration files:
.captain/your-suite/flakes.yaml
, .captain/your-suite/quarantines.yaml
, and
.captain/your-suite/timings.yaml
.
When you enable Cloud mode, you don't have to manually update your flakes, quarantines, and timing information. Instead, Captain Cloud will automatically detect flaky tests, let you quarantine them in the dashboard, and keep your timings up to date with historical runtimes of your tests. All without opening a PR!
Precedence
The Captain CLI accepts configuration via configuration file, environment variables, and CLI flags. It's possible and sometimes useful to set defaults and override them. To enable this behavior, the CLI has the following precedence for configuration: CLI flags take precedence over environment variables which take precedence over the configuration file.