---
title: index
description: Index a single documentation set to Elasticsearch, calls docs-builder --exporters elasticsearch. Exposes more options 
url: https://docs-v3-preview.elastic.dev/docs-builder/cli/docset/index-command
---

# index
Index a single documentation set to Elasticsearch, calls `docs-builder --exporters elasticsearch`. Exposes more options

## Usage

```
docs-builder index [options...] [-h|--help] [--version]
```


## Options

<definitions>
  <definition term="-es|--endpoint <string>">
    Elasticsearch endpoint, alternatively set env DOCUMENTATION_ELASTIC_URL (optional)
  </definition>
  <definition term="--path <string>">
    path to the documentation folder, defaults to pwd. (optional)
  </definition>
  <definition term="--api-key <string>">
    Elasticsearch API key, alternatively set env DOCUMENTATION_ELASTIC_APIKEY (optional)
  </definition>
  <definition term="--username <string>">
    Elasticsearch username (basic auth), alternatively set env DOCUMENTATION_ELASTIC_USERNAME (optional)
  </definition>
  <definition term="--password <string>">
    Elasticsearch password (basic auth), alternatively set env DOCUMENTATION_ELASTIC_PASSWORD (optional)
  </definition>
  <definition term="--search-num-threads <int?>">
    The number of search threads the inference endpoint should use. Defaults:   8 (optional)
  </definition>
  <definition term="--index-num-threads <int?>">
    The number of index threads the inference endpoint should use. Defaults:   8 (optional)
  </definition>
  <definition term="--bootstrap-timeout <int?>">
    Timeout in minutes for the inference endpoint creation. Defaults:   4 (optional)
  </definition>
  <definition term="--index-name-prefix <string>">
    The prefix for the computed index/alias names. Defaults:   semantic-docs (optional)
  </definition>
  <definition term="--force-reindex <bool?>">
    Force reindex strategy to semantic index, by default, we multiplex writes if the semantic index does not exist yet (optional)
  </definition>
  <definition term="--buffer-size <int?>">
    The number of documents to send to ES as part of the bulk. Defaults:   100 (optional)
  </definition>
  <definition term="--max-retries <int?>">
    The number of times failed bulk items should be retried. Defaults:   3 (optional)
  </definition>
  <definition term="--debug-mode <bool?>">
    Buffer ES request/responses for better error messages and pass ?pretty to all requests (optional)
  </definition>
  <definition term="--proxy-address <string>">
    Route requests through a proxy server (optional)
  </definition>
  <definition term="--proxy-password <string>">
    Proxy server password (optional)
  </definition>
  <definition term="--proxy-username <string>">
    Proxy server username (optional)
  </definition>
  <definition term="--disable-ssl-verification <bool?>">
    Disable SSL certificate validation (EXPERT OPTION) (optional)
  </definition>
  <definition term="--certificate-fingerprint <string>">
    Pass a self-signed certificate fingerprint to validate the SSL connection (optional)
  </definition>
  <definition term="--certificate-path <string>">
    Pass a self-signed certificate to validate the SSL connection (optional)
  </definition>
  <definition term="--certificate-not-root <bool?>">
    If the certificate is not root but only part of the validation chain pass this (optional)
  </definition>
</definitions>