--archive-cdx

CLI: --archive-cdx
REST: with_archive_cdx

ValuePATH

Writes a CDXJ index of the WARC’s records, which replay tools use to serve the archive without re-indexing it. Requires a WARC, as the output type or through --warc. On the server, the index is returned as a Link response header.

Example

Run locally

zshot -f archive.warc.gz \
  --archive-cdx archive.cdxj \
  https://zshot-cli.com/example_assets/zemu/index.html

{
  "url": "https://zshot-cli.com/example_assets/zemu/index.html",
  "output_type": "warc",
  "with_archive_cdx": true
}

curl -X POST http://127.0.0.1:3000/ \
  -H "Content-Type: application/json" \
  -d '{"url":"https://zshot-cli.com/example_assets/zemu/index.html","output_type":"warc","with_archive_cdx":true}' \
  -D - -o archive.warc.gz