elasticsearch/docs/reference/commands/cli-jvm-options.asciidoc
Ryan Ernst 3506d5e738
Document jvm options for cli tools (#92510)
This commit adds documentation for the CLI_JAVA_OPTS environment
variable.

closes #92503
2022-12-22 15:32:07 -08:00

13 lines
521 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[{tool-name}]` tool to 1GB.
[source,shell,subs=attributes+]
--------------------------------------------------
export CLI_JAVA_OPTS="-Xmx1g"
bin/elasticsearch-{tool-name} ...
--------------------------------------------------