meilisearch-tui 0.2.0

A TUI for Managing and Searching with Meilisearch

Meilisearch TUI

A TUI for Managing and Searching with Meilisearch.

Installation

Installing with pipx is recommended.

pipx install meilisearch-tui

Alternatively Meilisearch TUI can be installed with pip.

pip install meilisearch-tui

Usage

Start the TUI by running

meilisearch

The first time you start the app you will need to enter the server address and master key (if using one) into the configuration. If the MEILI_HTTP_ADDR and/or MEILI_MASTER_KEY environment variables are set, these values will be used for the meilisearch_url and master_key.

If you have not already created an index and loaded data, this can be done from the Load Data screen. Specifying an Index here will create the index if it does not already exist. Indexes that have already been created will show at the bottom of the screen. By default the first index will auto-populate the Index box.

To search, enter the index you want to search on, by default the first index found will pre-populate the box. Then type the desired search.

Contributing

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