A command-line interface tool for interacting with OpenSearch.
New developers must have gobrew installed for their convenience + Task to build cli
OpenSearch CLI provides a convenient way to manage and interact with OpenSearch clusters directly from your terminal. The tool supports various operations including querying, index management, and cluster administration tasks.
An available set of commands described in the docs
Config documentation is here
Release binaries could be downloaded from the GH releases.
- Go 1.24.6 or later
-
Clone the repository:
git clone https://github.com/dalet-oss/opensearch-cli.git cd opensearch-cli -
Build the project:
go build -o opensearch-cli
Run opensearch-cli --help to see available commands and options.
- Connect to OpenSearch clusters
- Execute queries and view results
- Manage indexes and mappings
- Monitor cluster health and stats
- Secure credential management
This project utilizes the following libraries:
- OpenSearch Go client
- spf13/Cobra: cli framework
- manifoldco/promptui: interactive prompts
- zalando/go-keyring: keyring creds storage for MacOS/Linux
Contributions are welcome! Please feel free to submit a Pull Request.
This project is licensed under the terms of the LICENSE file included in the repository.
- OpenSearch Project for providing the Go client library
- All contributors who have helped with the development of this tool