Skip to main content

CLI to inspect OpenSearch without the dashboard

Project description

osearch-cli

CLI to inspect OpenSearch without the dashboard.

Installation

pip install osearch-cli

Usage

# List all indices
os-cli --list

# Show documents from an index
os-cli my_index --limit 20

# Show documents with embedding vectors
os-cli my_index --show-embedding

Configuration

Set environment variables or use a .env file:

# Option 1: JSON config
OPENSEARCH_URL='{"endpoint": "https://...", "username": "admin", "password": "..."}'

# Option 2: URL
OPENSEARCH_URL=https://localhost:9200

# Option 3: Separate vars
OPENSEARCH_HOST=localhost
OPENSEARCH_PORT=9200

License

MIT

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

osearch_cli-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

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

osearch_cli-0.1.1-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file osearch_cli-0.1.1.tar.gz.

File metadata

  • Download URL: osearch_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for osearch_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2c7aae9bc02ee2ada20c1c6ed91a658d51c912e7263293bc1291787e4cd20f2c
MD5 a97e889c49dac8b83f4ce86ab93d35d7
BLAKE2b-256 3a74da520ce40677f3a52b986ec898079517aa7a42c408f5d10fed9eda1b610d

See more details on using hashes here.

Provenance

The following attestation bundles were made for osearch_cli-0.1.1.tar.gz:

Publisher: publish.yml on EnzoDeg40/opensearch-cli

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

File details

Details for the file osearch_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: osearch_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for osearch_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0e79328dc968b07a47ab3bc3e499c348a068a287be2ef13891601e00b563a10
MD5 35c8382f389429962a5c2fc8434d0087
BLAKE2b-256 ff2cca347aec85ff3ef4608d6e66c63ae01d5ffa3ce6d0ba0d74c78e5fdeffff

See more details on using hashes here.

Provenance

The following attestation bundles were made for osearch_cli-0.1.1-py3-none-any.whl:

Publisher: publish.yml on EnzoDeg40/opensearch-cli

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