﻿---
title: stack es helpers scroll-search cli command
description: Scroll through all search results, streaming documents as NDJSON to stdout, or returning a single JSON object when --json is set. Behaviour flags: --dry-run...
url: https://www.elastic.co/elastic/docs-builder/docs/4850/reference/elastic-cli/cli/stack/es/helpers/scroll-search
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es helpers scroll-search cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es helpers scroll-search --index <index> [options]
```

Scroll through all search results, streaming documents as NDJSON to stdout, or returning a single JSON object when --json is set.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--index string required">
    Target index
  </definition>
  <definition term="--query string">
    Query DSL clause as JSON (wrapped under "query"), e.g. '{"match_all":{}}'
  </definition>
  <definition term="--query-file string">
    Path to a file containing the full search body JSON (may include query, sort, aggs, ...)
  </definition>
  <definition term="--scroll string">
    Scroll keep-alive duration
    **Default:** `1m`
  </definition>
  <definition term="--size number">
    Documents per scroll batch
    **Default:** `1000`
  </definition>
  <definition term="--max-docs number">
    Maximum total documents to fetch (default: unlimited)
  </definition>
  <definition term="--input-file string">
    path to a JSON file to use as command input
  </definition>
  <definition term="--dry-run">
    validate all inputs and exit without performing any action (preview changes without applying them)
  </definition>
  <definition term="--no-validate">
    skip input validation and send the request as-is
  </definition>
</definitions>


## Global Options

<definitions>
  <definition term="--output-fields string">
    comma-separated list of fields to include in output (dot-notation supported)
  </definition>
  <definition term="--output-template string">
    Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
  </definition>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>