[CLI][Doc] Edit the doc for LMCache CLI#2870
Conversation
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on bringing the LMCache CLI documentation up-to-date. It introduces a clear overview of available commands, updates the developer's guide to reflect the current codebase structure, and enhances the getting started guide with practical, current examples and detailed explanations for key commands like Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces new ping and kvcache commands to the LMCache CLI and updates the documentation accordingly. The changes include adding descriptions for these commands in docs/source/cli/index.rst and docs/source/getting_started/cli.rst, updating example usage, and detailing their options and exit codes. The developer_guide/cli.rst was also updated to reflect the new command files and their registration. Feedback includes an inconsistency in the lmcache kvcache clear example's port number, which should be 8080 for consistency, and a suggestion to make the ALL_COMMANDS example in the developer guide more concise for better instructional clarity.
| .. code-block:: bash | ||
|
|
||
| # Clear all L1 (CPU) cache | ||
| lmcache kvcache clear --url http://localhost:8000 |
There was a problem hiding this comment.
The example for lmcache kvcache clear uses port 8000. However, the default port for the LMCache server is 8080, as correctly noted in other parts of the documentation (e.g., for lmcache ping kvcache). This inconsistency can be confusing for new users. Please update the port to 8080 for consistency.
| lmcache kvcache clear --url http://localhost:8000 | |
| lmcache kvcache clear --url http://localhost:8080 |
| ALL_COMMANDS: list[BaseCommand] = [ | ||
| MockCommand(), | ||
| KVCacheCommand(), | ||
| DescribeCommand(), # add here | ||
| PingCommand(), | ||
| QueryCommand(), | ||
| ServerCommand(), | ||
| ] |
There was a problem hiding this comment.
The example for registering a new command in ALL_COMMANDS has been updated to show the complete list of commands. While this reflects the current state of the code, it makes the example less clear for a developer following this step-by-step guide. A minimal example is more instructive for a tutorial. Please consider reverting to the previous, more concise version to better illustrate the process of adding a single command.
| ALL_COMMANDS: list[BaseCommand] = [ | |
| MockCommand(), | |
| KVCacheCommand(), | |
| DescribeCommand(), # add here | |
| PingCommand(), | |
| QueryCommand(), | |
| ServerCommand(), | |
| ] | |
| ALL_COMMANDS: list[BaseCommand] = [ | |
| MockCommand(), | |
| DescribeCommand(), # add here | |
| ] |
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
Signed-off-by: KuntaiDu <kuntai@uchicago.edu>
What this PR does / why we need it:
Updating the doc for CLI as it is outdated
Special notes for your reviewers:
If applicable: