meticulous download
Commands for downloading Meticulous artifacts to the local dataDir (default ~/.meticulous). All commands are idempotent — if the artifact already exists locally it will not be re-fetched.
download session
meticulous download session --sessionId=<id> [--format=<format>] [--apiToken=<token>]Purpose: Download a recorded session's data from Meticulous.
Options:
| Option | Type | Default | Description | |
|---|---|---|---|---|
--sessionId | string | — | ID of the session to download (required) | |
--format | json \ | multi-file | json | json downloads the original single JSON file. multi-file writes a structured directory tree. |
--outputDir | string | .meticulous/sessions | Output directory for multi-file format | |
--apiToken | string | — | Meticulous API token; falls back to OAuth login if omitted |
JSON format (default) downloads into dataDir/sessions/<sessionId>/:
- Session metadata JSON (recording info, timestamps, URL)
- Session data file (the full event log used for replay)
Multi-file format writes a structured directory tree. See the use-session-data skill for details on the output structure.
Examples:
# Download raw session data as JSON (default)
meticulous download session --sessionId=abc123
# Download in multi-file structured format
meticulous download session --sessionId=abc123 --format=multi-file
# Download to a custom output directory
meticulous download session --sessionId=abc123 --format=multi-file --outputDir=./test-datadownload replay
meticulous download replay --replayId=<id> [--apiToken=<token>]Purpose: Download a replay's metadata and full archive (screenshots, network logs, console logs) from Meticulous. Also generates human-readable log files from the raw NDJSON log.
What gets downloaded (into dataDir/replays/<replayId>/):
- Replay metadata JSON
- Full replay archive (screenshots, assets, logs)
Generated files (post-download):
logs.concise.txt— Human-readable logs with virtual timestamps and trace IDslogs.deterministic.txt— Likelogs.concise.txtbut with non-deterministic values stripped (event IDs replaced,[non-deterministic]entries removed). Suitable for diffing between replay runs.
Options:
| Option | Type | Required | Description |
|---|---|---|---|
--replayId | string | yes | ID of the replay to download |
--apiToken | string | no | Meticulous API token; falls back to OAuth login if omitted |
Example:
meticulous download replay --replayId=rpl_xyz
# Downloaded replay metadata to: /Users/you/.meticulous/replays/rpl_xyz/metadata.json
# Downloaded replay data to: /Users/you/.meticulous/replays/rpl_xyz/download test-run
meticulous download test-run [--testRunId=<id>] [--apiToken=<token>]Purpose: Download data for a Meticulous test run (defaults to the most recent run). Primarily used to inspect code coverage data.
What gets downloaded (into dataDir/test-runs/<testRunId>/):
- Coverage data and other artifacts within the requested
--scope
Options:
| Option | Type | Default | Description |
|---|---|---|---|
--testRunId | string | latest | ID of the test run to download; omit to fetch the most recent run |
--apiToken | string | — | Meticulous API token (no OAuth fallback — must be provided or set via env) |
--scope | string | coverage-only | What to download: coverage-only or app-container-logs |
Example:
# Download coverage for the latest test run
meticulous download test-run --apiToken=$TOKEN
# Download coverage for a specific test run
meticulous download test-run --apiToken=$TOKEN --testRunId=tr_abc
# Downloaded test run data to: /Users/you/.meticulous/test-runs/tr_abc/