Awesome
<div id="top"></div> <!-- *** Thanks for checking out the Best-README-Template. If you have a suggestion *** that would make this better, please fork the repo and create a pull request *** or simply open an issue with the tag "enhancement". *** Don't forget to give the project a star! *** Thanks again! Now go create something AMAZING! :D --> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links --> <!-- [![Contributors][contributors-shield]][contributors-url] --> <!-- [![Forks][forks-shield]](https://img.shields.io/github/forks/leopku/meilisearch-prompt?style=for-the-badge) --> <!-- [![Stargazers][stars-shield]](https://img.shields.io/github/stars/leopku/meilisearch-prompt?style=for-the-badge) --> <!-- [![Issues][issues-shield]][issues-url] --> <!-- [![AGPL License][license-shield]](https://www.gnu.org/licenses/agpl-3.0.txt) --> <!-- [![LinkedIn][linkedin-shield]][linkedin-url] --> <!--  --> <!--  --> <!--  --> <!-- [AGPL License](https://www.gnu.org/licenses/agpl-3.0.txt) --> <!-- PROJECT LOGO --> <br /> <!-- <div align="center"> <a href="https://github.com/leopku/meilisearch-prompt"> <img src="https://s3.bmp.ovh/imgs/2022/04/17/94abaf334c384dbc.gif" alt="Logo" width="800" height="400"> </a> --> <h3 align="center">meilisearch prompt</h3> <p align="center"> A command-line kit to manage a meilisearch server easily. <br /> <a href="https://github.com/leopku/meilisearch-prompt"><strong>Explore the docs »</strong></a> <br /> <br /> <!-- <a href="https://github.com/leopku/meilisearch-prompt">View Demo</a> · --> <a href="https://github.com/leopku/meilisearch-prompt/issues">Report Bug</a> · <a href="https://github.com/leopku/meilisearch-prompt/issues">Request Feature</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->About The Project
A command-line kit to manage a meilisearch server easily.
<p align="right">(<a href="#top">back to top</a>)</p>Built With
<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->Getting Started
A command-line kit to manage a meilisearch server with promption commands, indexes and field of one index.
Prerequisites
- meilisearch v0.26.0
Installation
- A meilisearch instance of v0.26.0
- Download binary from
- Running
meilisearch-promptwith interactive command-line mode../meilisearch-prompt interactive <your meilisearch host> - Manage your meilisearch instance
ls cd <your index> settings // get all settings of current index settings ranking-rules //get ranking-rules settings of current index settings ranking-rules words typo sort // set ranking-rules settings of current index
Usage
- ls - ls all indexes of current instance
- cd <uid> - select an index as current index
- create <uid> [primaryKey] - create a new index
- info - get info about current index
- settings - get all settings of current index
- settings <item> - get one item of current index settings.
- settings <item> [field1] [field2] [field2] - set one item of current index settings.
<!-- _For more examples, please refer to the [Documentation](https://example.com)_ --> <p align="right">(<a href="#top">back to top</a>)</p> <!-- ROADMAP -->item may be one of below:
displayed-attributes, searchable-attributes, filterable-attributes, sortable-attributes, ranking-rules, stop-words, distinct-attribute
Roadmap
- ls
- cd
- create
- settings
- displayed-attributes
- get
- set
- searchable-attributes
- get
- set
- filterable-attributes
- get
- set
- sortable-attributes
- get
- set
- ranking-rules
- get
- set
- stop-words
- get
- set
- distinct-attribute
- get
- set
- displayed-attributes
See the open issues for a full list of proposed features (and known issues).
<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTRIBUTING -->Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the AGPL v3 License. See LICENSE for more information.
Contact
https://github.com/leopku/meilisearch-prompt
<p align="right">(<a href="#top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS -->