[go: up one dir, main page]

Skip to content

A command line interface for meilisearch with auto-completion and Syntax Highlighting.

License

Notifications You must be signed in to change notification settings

leopku/meilisearch-prompt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


meilisearch prompt

A command-line kit to manage a meilisearch server easily.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

product-screenshot

A command-line kit to manage a meilisearch server easily.

(back to top)

Built With

(back to top)

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

  1. A meilisearch instance of v0.26.0
  2. Download binary from github release
  3. Running meilisearch-prompt with interactive command-line mode.
    ./meilisearch-prompt interactive <your meilisearch host>
  4. 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
    

(back to top)

Usage

  • ls - ls all indexes of current instance
  • cd - select an index as current index
  • create [primaryKey] - create a new index
  • info - get info about current index
  • settings - get all settings of current index
    • settings - get one item of current index settings.
    • settings [field1] [field2] [field2] - set one item of current index settings.

item may be one of below:

displayed-attributes, searchable-attributes, filterable-attributes, sortable-attributes, ranking-rules, stop-words, distinct-attribute

(back to top)

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

See the open issues for a full list of proposed features (and known issues).

(back to top)

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the AGPL v3 License. See LICENSE for more information.

(back to top)

Contact

@leopku

https://github.com/leopku/meilisearch-prompt

(back to top)

Acknowledgments

(back to top)

About

A command line interface for meilisearch with auto-completion and Syntax Highlighting.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages