elasticsearch/docs/reference/commands/cli-jvm-options.asciidoc
David Turner 885b436acf
Add elasticsearch- prefix to CLI tool docs (#101626)
The tools are called `elasticsearch-shard` and `elasticsearch-node` and
so on, but in the docs about their JVM options the `elasticsearch-`
prefix is omitted. This commit fixes that.
2023-10-31 13:27:03 -04:00

14 lines
537 B
Text

[[cli-tool-jvm-options-{tool-name}]]
[float]
==== JVM options
CLI tools run with 64MB of heap. For most tools, this value is fine. However, if
needed this can be overriden by setting the `CLI_JAVA_OPTS` environment variable.
For example, the following increases the heap size used by the
`pass:a[elasticsearch-{tool-name}]` tool to 1GB.
[source,shell,subs=attributes+]
--------------------------------------------------
export CLI_JAVA_OPTS="-Xmx1g"
bin/elasticsearch-{tool-name} ...
--------------------------------------------------