IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Run synthetic tests Working with params and secrets »

› › ›

Synthetics command reference

edit

Synthetics command reference

edit

`elastic-synthetics`

edit

[beta] This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features. Heartbeat uses the npx @elastic/synthetics command to run and report synthetic tests. It can also be used locally to help develop your tests.

SYNOPSIS

npx @elastic/synthetics [options] [files] [dir]

FLAGS

You will not need to use most command line flags — they have been implemented purely to interact with Heartbeat. However, there are some you may find useful. They are documented below.

--debug: Prints debug info.
--match <name>: Filters journey with the name or a matching tag.
--tags <name...>: Filters journey with the given tag(s).
--reporter: One of junit, default, or json. Use the JUnit reporter to provide easily parsed output to CI servers like Jenkins.
--no-headless: Runs with the browser in headful mode.
--inline: Instead of reading from a file, cat inline scripted journeys and pipe them through stdin. For example, cat path/to/file.js | npx @elastic/synthetics --inline.
--playwright-options <jsonstring>: JSON object to pass in custom Playwright options for the agent. Options passed will be merged with Playwright options defined in your synthetics.config.js file. Options defined via --playwright-options take precedence.
--screenshots <on|off|only-on-failure>: Captures screenshots for every step in the journey.
-h, --help: Shows help for the npx @elastic/synthetics command.

« Run synthetic tests Working with params and secrets »