---
title: stack es termvectors cli command
description: Get term vector information. Behaviour flags: --dry-run — validate all inputs and exit without performing any action 
url: https://www.elastic.co/elastic/docs-builder/docs/4089/reference/elastic-cli/cli/stack/es/termvectors
applies_to:
  - Elastic Cloud Serverless: Preview
  - Elastic Stack: Preview
---

# stack es termvectors cli command
<cli-modifiers>
</cli-modifiers>

```bash
elastic stack es termvectors --index <index> [options]
```

Get term vector information.
**Behaviour flags:**
`--dry-run` — validate all inputs and exit without performing any action

## Options

<definitions>
  <definition term="--index string required">
    The name of the index that contains the document.
  </definition>
  <definition term="--fields string[]">
    A list of fields to include in the statistics.
    It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
    **Repeatable:** pass `--fields` multiple times to supply more than one value
  </definition>
  <definition term="--field-statistics">
    If `true`, the response includes: * The document count (how many documents contain this field).
    - The sum of document frequencies (the sum of document frequencies for all terms in this field).
    - The sum of total term frequencies (the sum of total term frequencies of each term in this field).
  </definition>
  <definition term="--offsets">
    If `true`, the response includes term offsets.
  </definition>
  <definition term="--payloads">
    If `true`, the response includes term payloads.
  </definition>
  <definition term="--positions">
    If `true`, the response includes term positions.
  </definition>
  <definition term="--preference string">
    The node or shard the operation should be performed on.
    It is random by default.
  </definition>
  <definition term="--realtime">
    If true, the request is real-time as opposed to near-real-time.
  </definition>
  <definition term="--routing string">
    A custom value that is used to route operations to a specific shard.
    **Repeatable:** pass `--routing` multiple times to supply more than one value
  </definition>
  <definition term="--term-statistics">
    If `true`, the response includes: * The total term frequency (how often a term occurs in all documents).
    - The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact.
  </definition>
  <definition term="--version number">
    If `true`, returns the document version as part of a hit.
  </definition>
  <definition term="--version-type enum">
    The version type.
    **Values:** internal, external, external_gte
  </definition>
  <definition term="--doc string">
    An artificial document (a document not present in the index) for which you want to retrieve term vectors.
  </definition>
  <definition term="--filter string">
    Filter terms based on their tf-idf scores.
    This could be useful in order find out a good characteristic vector of a document.
    This feature works in a similar manner to the second phase of the More Like This Query.
  </definition>
  <definition term="--per-field-analyzer string">
    Override the default per-field analyzer.
    This is useful in order to generate term vectors in any fashion, especially when using artificial documents.
    When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.
  </definition>
  <definition term="--id string">
    A unique identifier for the document.
  </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>