Skip to main content

CLI for MeiliSearch

Project description

MeiliSearch CLI

Tests Status pre-commit.ci status Coverage PyPI version PyPI - Python Version

A CLI for working with MeiliSearch

Installation

Installation with pipx is recommended.

pipx install meilisearch-cli

Alternatively MeiliSearch CLI can be installed with pip.

pip install meilisearch-cli

Usage

All commands require both a url for MeiliSearch and a master key. These values can either be passed using the flags --url and --master-key, or can be read from the environment variables MEILI_HTTP_ADDR and MEILI_MASTER_KEY. The one exception is the health comman only requires the url, and does not take a master key.

As an example, if the MEILI_HTTP_ADDR and MEILI_MASTER_KEY vairables are not set you can retrieve the version with:

meilisearch-cli get-version --url http://localhost:7700 --master-key masterKey

or if the environment variables are set you can omit --url and --master-key:

meilisearch-cli get-version

To see a list of available commands run:

meilisearch-cli --help

To get information on individual commands add the --help flag after the command name. For example to get information about the add-documents command run:

meilisearch-cli add-documents --help

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

meilisearch-cli-0.1.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

meilisearch_cli-0.1.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file meilisearch-cli-0.1.0.tar.gz.

File metadata

  • Download URL: meilisearch-cli-0.1.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.8.0-1042-azure

File hashes

Hashes for meilisearch-cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 066c9652afa990508741e4f9dd5efefaa31d60cb814170597d6b446237d2922c
MD5 99ee39e66af3672d81215a40a944fcc1
BLAKE2b-256 efbc752c1e378a10fa96d4407b81ccd0b8aa16cff2fbf60df035707447027c63

See more details on using hashes here.

File details

Details for the file meilisearch_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: meilisearch_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.8.0-1042-azure

File hashes

Hashes for meilisearch_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 165de7cf4a26175360c833c124d04fdc5f3d39109887f5047d834a00a11556c6
MD5 d90d4e2b52d9b85f0161cda12022c29a
BLAKE2b-256 e8fff5583ce011214e92e5e7fc63f5e59d72719abd0deb349ba57ad2832184c7

See more details on using hashes here.

Supported by

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