Metadata-Version: 2.1
Name: meilisearch-tui
Version: 0.5.1
Summary: A TUI for Managing and Searching with Meilisearch
Home-page: https://github.com/sanders41/meilisearch-tui
License: MIT
Keywords: meilisearch,tui
Author: Paul Sanders
Author-email: psanders1@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: meilisearch-python-async (==1.1.0)
Requires-Dist: textual (==0.18.0)
Requires-Dist: uvloop (==0.17.0) ; sys_platform != "win32"
Project-URL: Documentation, https://github.com/sanders41/meilisearch-tui
Project-URL: Repository, https://github.com/sanders41/meilisearch-tui
Description-Content-Type: text/markdown

# 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
```

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, 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 interesting in contributing please see our [contributing guide](CONTRIBUTING.md)

