A TUI (Text User Interface) for Managing and Searching with Meilisearch from the terminal.

Installing with pipx is recommended.

pipx install meilisearch-tui

Alternatively Meilisearch TUI can be installed with pip.

pip install meilisearch-tui

Start the TUI by running

meilisearch

If you are using Meilisearch v1.7.0+ you can optionally use hybrid search by starting by passing the -h or --hybrid-search flag.

meilisearch -h

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, first add an index on the Add Index tab of the Index Management screen. Then data can be loaded from the ‘Load Data` tab.

To search, click on the index in the sidebar you want to search on, by default the first index will be selected. Then type the desired search.

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