elastic command line tool
Project description
🧰 elastic-tool
elastic-tool is a command line tool for interacting with Elasticsearch. It helps developers and data engineers to create, search, update, and delete indexes and documents via simple CLI commands.
📦 Installation
You can install the tool in editable/development mode:
git clone https://github.com/Potabk/elastic-tool.git
cd elastic-tool
pip install -e .
✅ After installation, the CLI command escli will be available in your terminal.
Quick Start
Check if CLI is available
escli --help
Add domain and token
A domain and token is necessary to interact with es, you can follow the next step to ensure elastic is accessible. There are currently two ways to add
-
Environment variables: set
ES_OM_DOMAINandES_OM_AUTHORIZATIONto have a login -
Keyring: Login through the command line, we will automatically store it in the operating system's keyring, In comparison, this method is safer and protects the secrets from being leaked. The login command looks like:
escli login --domain "your domain" --token "your token"
Features
Create and delete Elasticsearch indexes
Insert, update, delete documents
Perform search queries (DSL or keyword-based)
Support both inline JSON and file-based input
Environment config via ES_OM_DOMAIN and ES_OM_AUTHORIZATION env vars
Check and filter _doc not existed in es
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file escli_tool-0.2.3.tar.gz.
File metadata
- Download URL: escli_tool-0.2.3.tar.gz
- Upload date:
- Size: 1.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b586c5cf832c00c041480684d8f8b2e827744ee6703c338bec8883e89d9a15fd
|
|
| MD5 |
20cd68be65031e029e39f1fd86398a12
|
|
| BLAKE2b-256 |
786a7eb5bf88d4f2fa69cffec9063de154b1e210a67ab176555f3537b024a1bf
|
File details
Details for the file escli_tool-0.2.3-py3-none-any.whl.
File metadata
- Download URL: escli_tool-0.2.3-py3-none-any.whl
- Upload date:
- Size: 26.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c284e46e866ba871a21dcaff92f090b00dfe65944f0369d34aa0f5a4d4a8186
|
|
| MD5 |
3b883bfabda34930a950a232fced305d
|
|
| BLAKE2b-256 |
88fe2a196dc49a5bc6f947741333bf321e4ab4dd7d71ba68a2d3ca3b9a87c5bb
|