https://github.com/sanders41/meilisearch-tui

A TUI for Managing and Searching with Meilisearch
https://github.com/sanders41/meilisearch-tui

meilisearch python terminal-app text-user-interface textual tui

Last synced: about 2 months ago
JSON representation

A TUI for Managing and Searching with Meilisearch

• Host: GitHub
• URL: https://github.com/sanders41/meilisearch-tui
• Owner: sanders41
• License: mit
• Created: 2023-03-28T23:17:52.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-28T11:53:00.000Z (4 months ago)
• Last Synced: 2024-05-29T03:19:21.489Z (4 months ago)
• Topics: meilisearch, python, terminal-app, text-user-interface, textual, tui
• Language: Python
• Homepage:
• Size: 2.24 MB
• Stars: 11
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-meilisearch - Meilisearch TUI - A text user interface for searching and managing Meilisearch from the terminal (Tools / Community Tools)

README

        
# Meilisearch TUI

[![Tests Status](https://github.com/sanders41/meilisearch-tui/workflows/Testing/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-tui/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-tui/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-tui/main)

[![PyPI version](https://badge.fury.io/py/meilisearch-tui.svg)](https://badge.fury.io/py/meilisearch-tui)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-tui?color=5cc141)](https://github.com/sanders41/meilisearch-tui)

A TUI (Text User Interface) for Managing and Searching with [Meilisearch](https://github.com/meilisearch/meilisearch)

from the terminal.

![Search](https://raw.githubusercontent.com/sanders41/meilisearch-tui/main/assets/search.gif)

![Settings](https://raw.githubusercontent.com/sanders41/meilisearch-tui/main/assets/settings.png)

## Installation

Installing with [pipx](https://github.com/pypa/pipx) is recommended.

```sh

pipx install meilisearch-tui

```

Alternatively Meilisearch TUI can be installed with pip.

```sh

pip install meilisearch-tui

```

## Usage

Start the TUI by running

```sh

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.

```sh

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.

## Contributing

Contributions to this project are welcome. If you are interested in contributing please see our [contributing guide](CONTRIBUTING.md)