# --archive-cdx

Source: https://zshot-cli.com/reference/flags/archive/archive-cdx/
Markdown: https://zshot-cli.com/reference/flags/archive/archive-cdx/index.md
Section: [Reference](https://zshot-cli.com/reference/) › [Flags](https://zshot-cli.com/reference/flags/) › [Archive](https://zshot-cli.com/reference/flags/archive/)
CLI: `--archive-cdx` · REST: [`with_archive_cdx`](https://zshot-cli.com/reference/server/api/schema/#with_archive_cdx)
Value: `PATH`
License: [Standard](https://zshot-cli.com/support/licenses/standard)

Writes a [CDXJ](https://specs.webrecorder.net/cdxj/latest/) 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`](/reference/flags/archive/warc). On the server, the index is returned as a `Link` response header.

## Example

**CLI**

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

**JSON** — `POST /` body for the [API](/reference/server/api), Pro license

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

**curl**

```sh
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
```

## Related

Flags:

- [`--warc`](https://zshot-cli.com/reference/flags/archive/warc/)
- [`--warc-no-gzip`](https://zshot-cli.com/reference/flags/archive/warc-no-gzip/)

Topics:

- [WARC](https://zshot-cli.com/reference/formats/warc/)
- [API](https://zshot-cli.com/reference/server/api/)
- [CDXJ Spec](https://specs.webrecorder.net/cdxj/latest/)
- [pywb](https://pywb.readthedocs.io/en/latest/)

## Navigation

- [Examples](https://zshot-cli.com/examples/)
- [Download](https://zshot-cli.com/download/)
- [Purchase](https://zshot-cli.com/purchase/)
- [Reference](https://zshot-cli.com/reference/)
  - [Formats](https://zshot-cli.com/reference/formats/)
  - [Flags](https://zshot-cli.com/reference/flags/)
    - [Common](https://zshot-cli.com/reference/flags/common/)
    - [Agents](https://zshot-cli.com/reference/flags/agents/)
    - [Archive](https://zshot-cli.com/reference/flags/archive/)
      - [--archive-body-size-limit](https://zshot-cli.com/reference/flags/archive/archive-body-size-limit/)
      - **--archive-cdx**
      - [--archive-spill-max-bytes](https://zshot-cli.com/reference/flags/archive/archive-spill-max-bytes/)
      - [--crawl-allow-url](https://zshot-cli.com/reference/flags/archive/crawl-allow-url/)
      - [--crawl-concurrency](https://zshot-cli.com/reference/flags/archive/crawl-concurrency/)
      - [--crawl-delay](https://zshot-cli.com/reference/flags/archive/crawl-delay/)
      - [--crawl-deny-url](https://zshot-cli.com/reference/flags/archive/crawl-deny-url/)
      - [--crawl-link-depth](https://zshot-cli.com/reference/flags/archive/crawl-link-depth/)
      - [--crawl-link-selector](https://zshot-cli.com/reference/flags/archive/crawl-link-selector/)
      - [--crawl-links](https://zshot-cli.com/reference/flags/archive/crawl-links/)
      - [--crawl-max-links](https://zshot-cli.com/reference/flags/archive/crawl-max-links/)
      - [--crawl-media-sources](https://zshot-cli.com/reference/flags/archive/crawl-media-sources/)
      - [--crawl-page-timeout](https://zshot-cli.com/reference/flags/archive/crawl-page-timeout/)
      - [--crawl-sitemap-max-depth](https://zshot-cli.com/reference/flags/archive/crawl-sitemap-max-depth/)
      - [--crawl-url-is-sitemap](https://zshot-cli.com/reference/flags/archive/crawl-url-is-sitemap/)
      - [--har](https://zshot-cli.com/reference/flags/archive/har/)
      - [--har-capture-bodies](https://zshot-cli.com/reference/flags/archive/har-capture-bodies/)
      - [--har-captures-navigation](https://zshot-cli.com/reference/flags/archive/har-captures-navigation/)
      - [--warc](https://zshot-cli.com/reference/flags/archive/warc/)
      - [--warc-captures-navigation](https://zshot-cli.com/reference/flags/archive/warc-captures-navigation/)
      - [--warc-no-gzip](https://zshot-cli.com/reference/flags/archive/warc-no-gzip/)
    - [Browser](https://zshot-cli.com/reference/flags/browser/)
    - [Diagnostics](https://zshot-cli.com/reference/flags/diagnostics/)
    - [Document](https://zshot-cli.com/reference/flags/document/)
    - [Image](https://zshot-cli.com/reference/flags/image/)
    - [Navigator](https://zshot-cli.com/reference/flags/navigator/)
    - [Security](https://zshot-cli.com/reference/flags/security/)
    - [Server](https://zshot-cli.com/reference/flags/server/)
    - [Video](https://zshot-cli.com/reference/flags/video/)
  - [Agents](https://zshot-cli.com/reference/agents/)
  - [Configuration](https://zshot-cli.com/reference/configuration/)
  - [Crawling](https://zshot-cli.com/reference/crawling/)
  - [Docker](https://zshot-cli.com/reference/docker/)
  - [Exit Codes](https://zshot-cli.com/reference/exit_codes/)
  - [Linux](https://zshot-cli.com/reference/linux/)
  - [LLM Connections](https://zshot-cli.com/reference/llm_connections/)
  - [LLM Formatting](https://zshot-cli.com/reference/llm_formatting/)
  - [Local Inputs](https://zshot-cli.com/reference/inputs/)
  - [Navigator](https://zshot-cli.com/reference/navigator/)
  - [Security](https://zshot-cli.com/reference/security/)
  - [Server](https://zshot-cli.com/reference/server/)
  - [Shell completions](https://zshot-cli.com/reference/shell_completions/)
  - [Storage](https://zshot-cli.com/reference/storage/)
  - [Timeouts](https://zshot-cli.com/reference/timeouts/)
  - [Web Bot Auth](https://zshot-cli.com/reference/web_bot_auth/)
- [Support](https://zshot-cli.com/support/)
- [Changelog](https://zshot-cli.com/changelog/)

Site index: https://zshot-cli.com/llms.txt