﻿---
title: stack es text-structure test-grok-pattern cli command
description: Test a Grok pattern. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4097/reference/elastic-cli/cli/stack/es/text-structure/test-grok-pattern
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es text-structure test-grok-pattern cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es text-structure test-grok-pattern \
  --grok-pattern <grok-pattern> \
  --text <text> \
  [options]
```

Test a Grok pattern.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--grok-pattern string required">
    The Grok pattern to run on the text.
  </definition>
  <definition term="--text string[] required">
    The lines of text to run the Grok pattern on.
    **Repeatable:** pass `--text` multiple times to supply more than one value
  </definition>
  <definition term="--ecs-compatibility string">
    The mode of compatibility with ECS compliant Grok patterns.
    Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
    Valid values are `disabled` and `v1`.
  </definition>
  <definition term="--error-trace">
    When set to `true` Elasticsearch will include the full stack trace of errors
    when they occur.
  </definition>
  <definition term="--filter-path string">
    Comma-separated list of filters in dot notation which reduce the response
    returned by Elasticsearch.
    **Repeatable:** pass `--filter-path` multiple times to supply more than one value
  </definition>
  <definition term="--human">
    When set to `true` will return statistics in a format suitable for humans.
    For example `"exists_time": "1h"` for humans and
    `"exists_time_in_millis": 3600000` for computers. When disabled the human
    readable values will be omitted. This makes sense for responses being consumed
    only by machines.
  </definition>
  <definition term="--pretty">
    If set to `true` the returned JSON will be "pretty-formatted". Only use
    this option for debugging only.
  </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>
</definitions>


## Global Options

<definitions>
  <definition term="--json">
    output as JSON
  </definition>
</definitions>