# takeScreenshot

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](/maestro-studio/maestro-studio-overview.md), 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](/reference/commands-available/assertscreenshot.md). For a complete list of all available selectors, see the [Selectors](/reference/selectors.md) documentation.                                                                                                        |
| `label`   | Optional. A message to display when executing the evaluation.                                                                                                                                                                                                                                                                                                                                                |

### Usage examples

The following example saves a screenshot as `LoginScreen.png`.

```yaml
- takeScreenshot:
    path: LoginScreen
```

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

```yaml
- 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`.

```yaml
- takeScreenshot: MainScreen
```

{% hint style="info" %}
**Maestro CLI**

If you are using the [Maestro CLI](/maestro-cli/readme.md), 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](/maestro-flows/workspace-management/test-reports-and-artifacts.md) for details.
{% endhint %}

### Related content

Check the [Test reports and artifacts](/maestro-flows/workspace-management/test-reports-and-artifacts.md) to learn how to configure the output directory.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.maestro.dev/reference/commands-available/takescreenshot.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
