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.0.tar.gz (4.2 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.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osearch_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 4.2 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.0.tar.gz
Algorithm Hash digest
SHA256 6766b4fa5aec072d23a5f9db9b1966a51ac0da7f2472d2c08426634dedc99993
MD5 a3d6efa9f0139242de54f2c9b4dca26f
BLAKE2b-256 4cdb1c503b4dbff297f4db1a16ec4a0e81f3cc041b66803ce6ca515c6e8f6c98

See more details on using hashes here.

Provenance

The following attestation bundles were made for osearch_cli-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: osearch_cli-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e55fee573bac161693a34efe6b041592bcc361d8fa97342da91248e2acee5cf
MD5 fab6eeb9d222ace4a50718ac5aa19e9f
BLAKE2b-256 4b8afa2aa4be329a6b7484a6fef755156a961327015f9eb563cf800e8c00a6ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for osearch_cli-0.1.0-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