[WIP] Add terminal cli #157
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
xhluca
commented
Dec 1, 2025
xhluca
commented
- Updated the BM25S CLI to import the MCP server dynamically, enhancing modularity.
- Improved error messaging for missing MCP package, providing clearer installation instructions for users.
- Updated the BM25S CLI to import the MCP server dynamically, enhancing modularity. - Improved error messaging for missing MCP package, providing clearer installation instructions for users.
- Introduced a terminal-based CLI for `bm25s` to facilitate quick indexing and searching of documents from CSV, TXT, JSON, and JSONL files. - Implemented subcommands for `index` and `search`, allowing users to create an index and perform queries directly from the command line. - Enhanced README documentation with examples for using the CLI, improving user guidance for indexing and searching workflows. - Added comprehensive unit tests to validate CLI functionality and ensure robust error handling for various input scenarios.
- Introduced a new command-line argument `--save` to allow users to save search results to a specified JSON file. - Updated the README to include examples of using the new save feature, enhancing user documentation. - Added unit tests to verify the correct functionality of saving search results, ensuring robust implementation and validation of output structure.
- Added the ability to save indices to a central user directory (`~/.bm25s/indices/`) using the `-u` flag, improving organization and accessibility of user-created indices. - Updated command-line arguments for indexing and searching to include shorthand options, enhancing usability. - Introduced an interactive index picker for selecting indices from the user directory, requiring the `rich` package for a better user experience. - Enhanced README documentation with examples for the new user directory features, providing clearer guidance for users. - Added unit tests to validate the new user directory functionality and ensure robust error handling.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.