Awesome

MeiliSearch CLI

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

Example

Get Version

Get Document

Documentation

The MeiliSearch documentation sections can be displayed with clickable links to each section. The links are built based on the current state of the documentation and will automatically stay up-to-date with the latest documentation. To follow the links command + click on a Mac or control + click on Linux and Windows. Note that some terminals do not support clickable links. In this case the documentation tree will be displayed but not be clickable.

Compatibility with MeiliSearch

This package only guarantees compatibility with version v0.27 of MeiliSearch.

Contributing

Contributions to this project are welcome. If you are interesting in contributing please see our contributing guide