takeScreenshot

Capture a screenshot and save it to the test output directory.

The takeScreenshot command saves a screenshot of the current screen as a PNG file.

Parameters

The takeScreenshot command accepts the path parameter:

Parameter	Description
path	The file name for the screenshot, without the extension. Maestro saves the screenshot as a .png file. The path is relative to the Maestro workspace directory, not the flow file. By default, Maestro saves screenshots to a .maestro folder in your workspace. If you are using Maestro Studio, the files are saved in the .maestro/screenshots folder.
cropOn	Optional. A selector to narrow the screenshot to just an element or container that you care about. Often used with assertScreenshot. For a complete list of all available selectors, see the Selectors documentation.
label	Optional. A message to display when executing the evaluation.

Usage examples

The following example saves a screenshot as LoginScreen.png.

- takeScreenshot:
    path: LoginScreen

This next example is the same login screen, but crops to the area containing the login controls

- takeScreenshot:
    path: LoginScreen
    cropOn:
      id: LoginFormContainer
    label: Take a screenshot of the login form

You can also use a shorthand syntax. The following example saves a screenshot as MainScreen.png.

- takeScreenshot: MainScreen

Maestro CLI

If you are using the Maestro CLI, you can override the default output location with the --test-output-dir flag when running maestro test or with testOutputDir in your workspace config. See Test reports and artifacts for details.

Related content

Check the Test reports and artifacts to learn how to configure the output directory.