# Meilisearch TUI
[](https://github.com/sanders41/meilisearch-tui/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
[](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-tui/main)
[](https://badge.fury.io/py/meilisearch-tui)
[](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.
## 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)
Raw data
{
"_id": null,
"home_page": "https://github.com/sanders41/meilisearch-tui",
"name": "meilisearch-tui",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "meilisearch,tui",
"author": "Paul Sanders",
"author_email": "psanders1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7c/af/45fb508c440a6dd45c6e65dd4b716703251ee3ca8fcf49397e28f45e3970/meilisearch_tui-0.9.0.tar.gz",
"platform": null,
"description": "# Meilisearch TUI\n\n[](https://github.com/sanders41/meilisearch-tui/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)\n[](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-tui/main)\n[](https://badge.fury.io/py/meilisearch-tui)\n[](https://github.com/sanders41/meilisearch-tui)\n\nA TUI (Text User Interface) for Managing and Searching with [Meilisearch](https://github.com/meilisearch/meilisearch)\nfrom the terminal.\n\n\n\n\n## Installation\n\nInstalling with [pipx](https://github.com/pypa/pipx) is recommended.\n\n```sh\npipx install meilisearch-tui\n```\n\nAlternatively Meilisearch TUI can be installed with pip.\n\n```sh\npip install meilisearch-tui\n```\n\n## Usage\n\nStart the TUI by running\n\n```sh\nmeilisearch\n```\n\nIf you are using Meilisearch v1.7.0+ you can optionally use hybrid search by starting by passing\nthe `-h` or `--hybrid-search` flag.\n\n```sh\nmeilisearch -h\n```\n\nThe first time you start the app you will need to enter the server address and master key (if using\none) into the configuration. If the `MEILI_HTTP_ADDR` and/or `MEILI_MASTER_KEY` environment variables\nare set, these values will be used for the `meilisearch_url` and `master_key`.\n\nIf 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 \u2018Load Data` tab.\n\nTo search, click on the index in the sidebar you want to search on, by default the first index will\nbe selected. Then type the desired search.\n\n## Contributing\n\nContributions to this project are welcome. If you are interested in contributing please see our [contributing guide](CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A TUI for Managing and Searching with Meilisearch",
"version": "0.9.0",
"project_urls": {
"Documentation": "https://github.com/sanders41/meilisearch-tui",
"Homepage": "https://github.com/sanders41/meilisearch-tui",
"Repository": "https://github.com/sanders41/meilisearch-tui"
},
"split_keywords": [
"meilisearch",
"tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f32e81aad758aa37ae3ca7cf12f7ca907dd01fcba8b8b177d458ff279294a49",
"md5": "bc254c7cdb08afbcf5d802acd940c9b5",
"sha256": "49a651de51222d453e148fe0e54dd8bca92da7ace2f145f8f1602d37abab4142"
},
"downloads": -1,
"filename": "meilisearch_tui-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc254c7cdb08afbcf5d802acd940c9b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 19676,
"upload_time": "2024-03-15T14:42:06",
"upload_time_iso_8601": "2024-03-15T14:42:06.688006Z",
"url": "https://files.pythonhosted.org/packages/0f/32/e81aad758aa37ae3ca7cf12f7ca907dd01fcba8b8b177d458ff279294a49/meilisearch_tui-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7caf45fb508c440a6dd45c6e65dd4b716703251ee3ca8fcf49397e28f45e3970",
"md5": "c845600877bbd96c125f0be40de9b49c",
"sha256": "0b6140c20c128ed6fa9584bcfbe86153aba3414a225c698b9324e12d72a8307f"
},
"downloads": -1,
"filename": "meilisearch_tui-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "c845600877bbd96c125f0be40de9b49c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 14583,
"upload_time": "2024-03-15T14:42:08",
"upload_time_iso_8601": "2024-03-15T14:42:08.853128Z",
"url": "https://files.pythonhosted.org/packages/7c/af/45fb508c440a6dd45c6e65dd4b716703251ee3ca8fcf49397e28f45e3970/meilisearch_tui-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 14:42:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanders41",
"github_project": "meilisearch-tui",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meilisearch-tui"
}
JSON
