Introduction
Meet the independent, unofficial open-source ES CLI for fast, scriptable Elasticsearch cluster operations.
ES CLI is a fast, scriptable command-line interface for Elasticsearch. Inspect cluster health, manage indices and documents, run searches, and operate ingest pipelines and ILM policies from your terminal.
It is designed for both human operators and coding agents. Commands that return
API data support -o json and -o yaml for machine-readable output.
The binary is es. Connection settings can come from CLI flags, environment
variables, or named profiles in ~/.config/es-cli/config.yaml.
Features
- Cluster operations: health, stats, settings, pending tasks, allocation explanations, nodes, hot threads, and shards.
- Indices: list, inspect, create, delete, open, close, configure, rollover, and reindex; plus aliases, index templates, and component templates.
- Documents and search: document get/index/delete/bulk/mget, Query DSL, SQL, count, multi-search, and field capabilities.
- Data flows: ingest pipeline management and simulation, plus ILM policy management and per-index lifecycle explanations.
- Secure connections: basic auth, API keys, bearer tokens, custom CAs, TLS controls, and multiple named profiles.
- Agent-friendly:
-o json|yaml,--read-only,--no-input,--quiet, environment-variable configuration, confirmations, and idempotent flags.
Next steps
Installation
Install the prebuilt binary or build from source.
Authentication
Connect with basic auth, an API key, or a bearer token.
Quick start
Configure a cluster and run your first commands.
Agents
Structured output, safety flags, and non-interactive use.
Independent project. Not affiliated with, endorsed by, or sponsored by Elastic or Elasticsearch. All product names, logos, and trademarks are the property of their respective owners and are used for identification purposes only.