Skip to content

pipemason export

Download the complete event log for a run or program, with its metadata, as a local file. The same export is available from the run and program pages in the dashboard.

Usage

pipemason export --run <id> [--format json|ndjson|md] [--out <path>]
pipemason export --program <id> [--format json|ndjson|md] [--out <path>]

Pass exactly one of --run or --program. The id is the cloud run or program id shown by pipemason status and in the dashboard URL. The runner must be paired (pipemason login); the export is scoped to your organization.

Formats

  • json (default) — one document: header, events, escalations, metadata. Program exports also carry stories.
  • ndjson — streamed one JSON object per line (header, then each story and event, then metadata). Use this for large runs or piping into other tools.
  • md — a human-readable Markdown report with a summary and an event table.

What it does

  • Writes the export to --out, or to an auto-named file such as pipemason-run-<id>-<date>.json in the current directory. When stdout is not a terminal the export is piped to stdout instead.
  • Values under keys that look like secrets (token, key, password, credential, auth) are replaced with [REDACTED] before they leave the cloud.
  • Every export is recorded in your organization’s audit log.
  • Exports are rate limited per organization, and a run or program with more than 100,000 events is refused (HTTP 413). Contact support for larger exports.

Exit codes

  • 0 — export written.
  • 1 — usage error (both or neither of --run / --program, bad format).
  • 2 — not paired.
  • 3 — run or program not found in your organization.
  • 4 — rate limited; retry after the reported delay.
  • 5 — export too large.
  • 6 — network or server error.

Examples

# Full JSON export of a run into the current directory
pipemason export --run 01M3AG5JH3GSP45973PFVD6SNH

# Stream a big program as NDJSON and count its events
pipemason export --program 01M2X... --format ndjson | grep -c '"type":"event"'

# Markdown report for a ticket or post-mortem
pipemason export --run 01M3AG... --format md --out run-report.md