Skip to main content
Available since CLI v8.8.0.
The checkly assets command lets you list and download result assets from the terminal. Assets are the artifacts produced by a check run or test session result, such as logs, Playwright traces, videos, screenshots, packet captures, and reports. Every asset belongs to a single result. Identify that result with --result-id together with either --check-id (for a scheduled check result) or --test-session-id (for a test-session result).
Before using checkly assets, ensure you have:
  • Checkly CLI installed
  • Valid Checkly account authentication (run npx checkly login if needed)
  • A check result ID or test-session result ID, and its corresponding check ID or test session ID
For additional setup information, see CLI overview.

​
Usage

Terminal

​
Subcommands

​
checkly assets list

List the assets available for a check result or a test-session result. Use filters to narrow by asset type or name, then copy the exact Asset value to use with checkly assets download. Usage:
Terminal
Options:

​
List Options

​
--result-id
string
required
The check result ID or test-session result ID to list assets for.Usage:
Terminal
​
--check-id
string
The check ID for a scheduled check result. Use exactly one of --check-id or --test-session-id.Usage:
Terminal
​
--test-session-id
string
The test session ID for a test-session result. Use exactly one of --check-id or --test-session-id.Usage:
Terminal
​
--type
string
default:"all"
Filter assets by type. Available values: log, trace, video, screenshot, pcap, report, file, all.Usage:
Terminal
​
--asset
string
Filter assets by their exact Asset/Name value, or by a glob pattern.Usage:
Terminal
​
--view
string
default:"table"
Choose the human-readable view. Use table to see exact Asset values for download, or tree for a hierarchical overview. This flag is ignored when --output=json.Usage:
Terminal
​
--output, -o
string
default:"table"
Set the output format. Use json for programmatic access or md for markdown.Usage:
Terminal

​
List Examples

Terminal

​
checkly assets download

Download assets for a check result or a test-session result. You must select assets with --type or --asset — use --type all to download everything. By default, files are written to ./checkly-assets/<source>-<result-id>. Usage:
Terminal
Options:
Pass --type or --asset to select which assets to download. Use --type all to download all assets for the result.

​
Download Options

​
--result-id
string
required
The check result ID or test-session result ID to download assets from.Usage:
Terminal
​
--check-id
string
The check ID for a scheduled check result. Use exactly one of --check-id or --test-session-id.Usage:
Terminal
​
--test-session-id
string
The test session ID for a test-session result. Use exactly one of --check-id or --test-session-id.Usage:
Terminal
​
--type
string
Select assets by type. Available values: log, trace, video, screenshot, pcap, report, file, all. Use --type all to download every asset.Usage:
Terminal
​
--asset
string
Select a single asset by its exact Asset/Name value, or by a glob pattern.Usage:
Terminal
​
--dir
string
Directory to write the downloaded assets into. When omitted, assets are written to ./checkly-assets/<source>-<result-id>.Usage:
Terminal
​
--force
boolean
default:"false"
Overwrite existing files in the target directory. Cannot be combined with --skip-existing.Usage:
Terminal
​
--skip-existing
boolean
default:"false"
Skip files that already exist in the target directory. Cannot be combined with --force.Usage:
Terminal
​
--output, -o
string
default:"table"
Set the output format. Use json for programmatic access, including the resolved directory and downloaded file paths.Usage:
Terminal

​
Download Examples

Terminal