Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ There are first-class integrations for GitHub Actions, Bitrise, Bitbucket Pipeli

### How do I get videos, logs and test reports?

Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id <uuid> --download-artifacts ALL`. Each result in the console also has a download menu for its logs, reports, app binary and workspace. Reports are available as `junit`, `html`, `html-detailed` and `allure` via `--report`. See [Artifacts & Downloads](artifacts/artifacts.md) and [Report Formats](artifacts/report-formats.md).
Pass `--download-artifacts ALL` (or `FAILED`) to a `dcd cloud` run, or fetch them after the fact with `dcd artifacts --upload-id <uuid> --download-artifacts ALL`. Each result in the console also has a download menu for its logs, reports, app binary and workspace. Reports are available as `junit` and `html` via `--report`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. See [Artifacts & Downloads](artifacts/artifacts.md) and [Report Formats](artifacts/report-formats.md).

### Is there a time limit on a test?

Expand Down
6 changes: 3 additions & 3 deletions artifacts/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ dcd artifacts --upload-id <uuid> --download-artifacts ALL
# Download a JUnit report
dcd artifacts --upload-id <uuid> --report junit

# Download an Allure report
dcd artifacts --upload-id <uuid> --report allure --allure-path ./allure-report.html
# Download the HTML report
dcd artifacts --upload-id <uuid> --report html --html-path ./report.zip
```

See the [`dcd artifacts` reference](../cli/dcd-artifacts.md) for the full flag list.

### From the Console

Each test result in the [DeviceCloud console](https://console.devicecloud.dev) has a download menu with the files for that result: `commands.json`, the Maestro log, Maestro stdout and stderr, the logcat (Android), the HTML, JUnit and Allure reports (when the run generated them), the app binary (APK or APP build) and the workspace. Videos and screenshots are shown on the result page; to download them in bulk, use `--download-artifacts` or `dcd artifacts`.
Each test result in the [DeviceCloud console](https://console.devicecloud.dev) has a download menu with the files for that result: `commands.json`, the Maestro log, Maestro stdout and stderr, the logcat (Android), the HTML, JUnit and Allure reports (when the run generated them; Allure is deprecated and will be removed on 7 December 2026), the app binary (APK or APP build) and the workspace. Videos and screenshots are shown on the result page; to download them in bulk, use `--download-artifacts` or `dcd artifacts`.

## Artifact Archive Structure

Expand Down
23 changes: 16 additions & 7 deletions artifacts/report-formats.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
# Report Formats

Device Cloud supports the standard Maestro report formats as well as [Allure](https://allurereport.org/), a widely used open-source reporting framework that provides enhanced visualisation and history tracking.
Device Cloud supports the standard Maestro report formats: JUnit and HTML.

::: warning
`allure` and `html-detailed` are deprecated and **will be removed on 7 December 2026**. From that date, runs that pass them still run and don't fail:

- `--report html-detailed` gets the standard HTML report.
- `--report allure` gets no report.

To move now, use `--report html` or `--report junit`.
:::

## Available Reports

We support the following report types:

- `junit`
- `html`
- `html-detailed`
- `allure`
- `html-detailed` (deprecated, removed on 7 December 2026)
- `allure` (deprecated, removed on 7 December 2026)

You can enable each report using `--report <type>`.

The CLI will automatically download the report to your working directory for you after the run finishes. To change the download path, use the flag for that report format:

- `--junit-path <path>` (default `./report.xml`)
- `--html-path <path>` (default `./report.html`, applies to `html` and `html-detailed`)
- `--html-path <path>` (default `./report.zip`, applies to `html` and `html-detailed`)
- `--allure-path <path>` (default `./report.html`)

::: info
The `html` and `html-detailed` reports are downloaded as a ZIP archive (the report plus its screenshots, videos and logs), even though the default file name is `report.html`. Pass `--html-path ./report.zip` so the file has the right extension, then unzip it to view the report.
The `html` and `html-detailed` reports are downloaded as a ZIP archive (the report plus its screenshots, videos and logs). Unzip it to view the report.
:::

(`--artifacts-path` is a separate flag that sets the download path for the artifacts zip and requires `--download-artifacts`.)
Expand All @@ -33,8 +42,8 @@ JUnit reports are XML-based and are generally the standard format for CI/CD repo

### HTML and HTML-Detailed

HTML reports are human-readable provide a summary overview of a test run including failure screenshots. Detailed reports include test steps alongside everything from standard HTML reports. Both are delivered as a ZIP containing the report and the files it links to.
HTML reports are human-readable and provide a summary of a test run, including failure screenshots. Both are delivered as a ZIP containing the report and the files it links to. Detailed reports add the test steps to everything in a standard HTML report. `html-detailed` is deprecated: from 7 December 2026 it gives the standard HTML report.

### Allure

Allure reports are HTML-based and include rich and comprehensive visualisations of test results. They are downloaded as a single, self-contained HTML file. Read more [here](https://allurereport.org/).
Allure reports are HTML-based and are downloaded as a single, self-contained HTML file. Allure is deprecated and will be removed on 7 December 2026. From that date, runs that pass `--report allure` get no report. Use `html` or `junit` instead.
2 changes: 1 addition & 1 deletion ci-cd/bitbucket-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Most pipe variables map to the [`dcd cloud`](../cli/dcd-cloud.md) CLI flag of th
| `IOS_DEVICE`, `IOS_VERSION` | iOS device + version. |
| `ENV_LIST` | Newline-separated `KEY=VALUE` env vars injected into flows. |
| `INCLUDE_TAGS` / `EXCLUDE_TAGS` | Filter flows by Maestro tag. |
| `REPORT` | `junit`, `html`, `html-detailed`, `allure`. |
| `REPORT` | `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |
| `JUNIT_PATH` | Where to write the JUnit report (default `./report.xml`). |
| `DOWNLOAD_ARTIFACTS` | `ALL` or `FAILED` — downloads logs/screenshots/videos. |
| `ASYNC` | `"true"` to fire-and-forget. |
Expand Down
2 changes: 1 addition & 1 deletion ci-cd/eas-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag
| `--env KEY=value` | Inject environment variables into your flows. Repeatable. |
| `--name <name>` | Custom name for this test run. |
| `--retry <n>` | Number of automatic retries on failure (max `2`). Retries are free. |
| `--report <format>` | `junit`, `html`, `html-detailed`, `allure`. See [Report Formats](../artifacts/report-formats.md). |
| `--report <format>` | `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |

### Execution Options

Expand Down
2 changes: 1 addition & 1 deletion ci-cd/github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ See the [Devices & OS Versions](../getting-started/devices-configuration.md) pag
| `env` | No | — | Multiline list of environment variables (`KEY=value`) to inject into flows. |
| `name` | No | PR title or commit message | Custom name for this test run, visible in the console. Defaults to the pull request's title on PR events, the commit message on push events, and the commit SHA otherwise. |
| `retry` | No | `0` | Number of retries on failure (max `2`). Retries are free — same as pressing retry in the UI. |
| `report` | No | — | Report format. Options: `junit`, `html`, and from v2.6.0 `html-detailed`. See [Report Formats](../artifacts/report-formats.md). |
| `report` | No | — | Report format. Options: `junit`, `html`, and from v2.6.0 `html-detailed`. `html-detailed` is deprecated and will be removed on 7 December 2026. See [Report Formats](../artifacts/report-formats.md). |

### Android-Specific Options

Expand Down
10 changes: 5 additions & 5 deletions cli/dcd-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ dcd artifacts --upload-id <id> [flags]

| Flag | Description |
|------|-------------|
| `--report <format>` | Download a test report. Options: `junit`, `html`, `html-detailed`, `allure`. Mutually exclusive with `--download-artifacts` |
| `--allure-path <path>` | Output path for the Allure report (default: `./report.html`). Requires `--report allure` |
| `--html-path <path>` | Output path for the HTML report (default: `./report.html`). Requires `--report html` or `html-detailed`. The HTML report downloads as a ZIP, so use a `.zip` path such as `./report.zip` |
| `--report <format>` | Download a test report. Options: `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026. Mutually exclusive with `--download-artifacts` |
| `--allure-path <path>` | Output path for the Allure report (default: `./report.html`). Requires `--report allure`. Deprecated, removed on 7 December 2026 |
| `--html-path <path>` | Output path for the HTML report (default: `./report.zip`). Requires `--report html` or `html-detailed`. The HTML report downloads as a ZIP, so use a `.zip` path |
| `--junit-path <path>` | Output path for the JUnit report (default: `./report.xml`). Requires `--report junit` |

### Other
Expand All @@ -59,9 +59,9 @@ dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --download-artifa
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report junit
```

**Download an Allure report to a custom path:**
**Download the HTML report to a custom path:**
```bash
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report allure --allure-path ./allure-report.html
dcd artifacts --upload-id 123e4567-e89b-12d3-a456-426614174000 --report html --html-path ./html-report.zip
```

## Using with Async Runs
Expand Down
4 changes: 2 additions & 2 deletions cli/dcd-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ Attach Git and pull request metadata to a run. These values are displayed in the
| `--json-file` | Write JSON results to a file (`<upload_id>_dcd.json` by default). Exits `0` even if the test run fails; infrastructure errors still exit `1` |
| `--json-file-name <name>` | Custom name (or relative path) for the JSON file. Requires `--json-file` |
| `--dry-run` | Simulate the run without uploading or triggering a test — useful for debugging workflow issues |
| `--report <format>`, `--format` | Generate and download a report. Options: `junit`, `html`, `html-detailed`, `allure` (see [Report Formats](../artifacts/report-formats.md)) |
| `--report <format>`, `--format` | Generate and download a report. Options: `junit`, `html`, `html-detailed`, `allure`. `html-detailed` and `allure` are deprecated and will be removed on 7 December 2026 (see [Report Formats](../artifacts/report-formats.md)) |
| `--junit-path <path>` | Output path for the JUnit report (requires `--report junit`) |
| `--html-path <path>` | Output path for the HTML report (requires `--report html` or `html-detailed`). The HTML report downloads as a ZIP, so use a `.zip` path such as `./report.zip` |
| `--allure-path <path>` | Output path for the Allure report (requires `--report allure`) |
| `--allure-path <path>` | Output path for the Allure report (requires `--report allure`). Deprecated, removed on 7 December 2026 |
| `--download-artifacts <ALL\|FAILED>` | Download test artifacts after completion (see [Artifacts](../artifacts/artifacts.md)) |
| `--artifacts-path <path>` | Output path for the artifacts zip (default `./artifacts.zip`). Requires `--download-artifacts` |
| `--debug` | Enable verbose debug logging |
Expand Down
4 changes: 2 additions & 2 deletions mcp/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Download a completed run's artifacts zip (videos, logs and screenshots) to local
| `uploadId` | string | **Required.** UUID of the upload to download artifacts for |
| `type` | `ALL` \| `FAILED` | Which tests to include artifacts for (default `ALL`) |
| `artifactsPath` | string | Where to write the artifacts zip (default `./artifacts.zip`) |
| `report` | `junit` \| `allure` \| `html` | Also download a formatted report of this type |
| `reportPath` | string | Where to write the report (defaults by type: `report.xml` for `junit`, otherwise `report.html`). The `html` report is a ZIP, so give it a `.zip` path |
| `report` | `junit` \| `allure` \| `html` | Also download a formatted report of this type. `allure` is deprecated and will be removed on 7 December 2026 |
| `reportPath` | string | Where to write the report (defaults by type: `report.xml` for `junit`, `report.zip` for `html`, `report.html` for `allure`). The `html` report is a ZIP |

Returns `{ uploadId, artifactsPath, reportPath, warnings }`. A **non-empty `warnings` array means a download could not be produced** — most often because the run has no results yet. An empty array means success. See [Artifacts & Downloads](../artifacts/artifacts.md) and [Report Formats](../artifacts/report-formats.md).

Expand Down
Loading