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
1 maintainer
Metadata
1 maintainer
Release files for meilisearch-cli 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| meilisearch-cli-0.11.0.tar.gz | 13.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| meilisearch_cli-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.9 kB
Release files / meilisearch-cli-0.11.0.tar.gz
| Download URL | meilisearch-cli-0.11.0.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3faab3ce882fe7c19a364d56092499ee5081978344dd54cf472a5ff60f512773
|
|
BLAKE2b-256 checksum How to use checksums |
066784af3b82841e628bed4f5361a14f609822b802209e533d9d4db0b247ba16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure
|
Release files / meilisearch_cli-0.11.0-py3-none-any.whl
| Download URL | meilisearch_cli-0.11.0-py3-none-any.whl |
|---|---|
| Size | 15.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dee833b5f6650fbfc1a2ae0b17aa9a9ba0dc17253a964ac91d5ad7bfb3a28d91
|
|
BLAKE2b-256 checksum How to use checksums |
db1513a920b7321ffefb60ecbd6a54f36f1a5b971b40f3882c024ffe566a3b13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1022-azure
|
