Skip to main content

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_DOMAIN and ES_OM_AUTHORIZATION to 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

escli_tool-0.2.5.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

escli_tool-0.2.5-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file escli_tool-0.2.5.tar.gz.

File metadata

  • Download URL: escli_tool-0.2.5.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for escli_tool-0.2.5.tar.gz
Algorithm Hash digest
SHA256 81d9da313d5f0207247bcc6e6f1a4e717d3f76a421dc63d321b4a679caa0e052
MD5 afdeb413910f2e4196db9021056f556a
BLAKE2b-256 91106082ed681da827f2604deca0a71f96397a87e16c957253f8e58c148c8cb0

See more details on using hashes here.

Provenance

The following attestation bundles were made for escli_tool-0.2.5.tar.gz:

Publisher: publish.yml on cosdt/elastic-tool

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file escli_tool-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: escli_tool-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for escli_tool-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2e331330223f2a0f44e9e775166fd6e6a23d604722d83a9067a1de79b588ee86
MD5 23799cd7ba88068e3953bccbcbaf3e2f
BLAKE2b-256 df90ad14cf6c792869f1e83d4fef22b7947a926d55c10db8e414ca7e33fde405

See more details on using hashes here.

Provenance

The following attestation bundles were made for escli_tool-0.2.5-py3-none-any.whl:

Publisher: publish.yml on cosdt/elastic-tool

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page