Update README.md to reflect changes in lkr-dev-cli installation ins…
#22
Conversation
…tructions - Updated usage examples to include the `[all]` extra for `lkr-dev-cli` in installation and command execution instructions. - Ensured consistency in command examples throughout the README for better clarity on using the CLI.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @bwebs, 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 enhancing the accuracy and usability of the project's documentation by updating the README.md file. The primary goal is to ensure that all instructions and examples for installing and using the lkr-dev-cli tool correctly specify the [all] extra, providing users with the most up-to-date and functional guidance.
Highlights
- Documentation Update: Updated the
README.mdto reflect the correct installation and usage instructions forlkr-dev-cli, specifically by including the[all]extra. - Command Consistency: Ensured all command examples within the
README.mdconsistently use thelkr-dev-cli[all]syntax, improving clarity and accuracy for users.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to use the [all] extra for lkr-dev-cli installation and usage examples. The changes are consistent and correctly reflect the project's packaging setup. My review includes a suggestion to improve the clarity of the installation instructions by explaining the purpose of the [all] extra and using code blocks for commands, which is a common best practice for technical documentation.
| `uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). You can start using `lkr` by running `uv run --with lkr-dev-cli[all] lkr --help`. | ||
|
|
||
| Alternatively, you can install `lkr` with `pip install lkr-dev-cli` and use commands directly like `lkr <command>`. | ||
| Alternatively, you can install `lkr` with `pip install lkr-dev-cli[all]` and use commands directly like `lkr <command>`. |
There was a problem hiding this comment.
While the change to add [all] is correct, the documentation could be clearer for new users. I suggest briefly explaining what [all] is for and using distinct code blocks for the uv and pip commands. This improves readability and makes the commands easier to copy and paste.
| `uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). You can start using `lkr` by running `uv run --with lkr-dev-cli[all] lkr --help`. | |
| Alternatively, you can install `lkr` with `pip install lkr-dev-cli` and use commands directly like `lkr <command>`. | |
| Alternatively, you can install `lkr` with `pip install lkr-dev-cli[all]` and use commands directly like `lkr <command>`. | |
| `uv` makes everyone's life easier. Go [install it](https://docs.astral.sh/uv/getting-started/installation/). | |
| To use `lkr` with all optional features, we recommend installing with the `[all]` extra. | |
| You can run `lkr` on-demand with `uv`: | |
| ```bash | |
| uv run --with lkr-dev-cli[all] lkr --help |
Alternatively, you can install it with pip to use commands like lkr <command> directly:
pip install lkr-dev-cli[all]
…tructions
[all]extra forlkr-dev-cliin installation and command execution instructions.