Update README.md - add note on non-interactive mode support #22 - #23
Conversation
Update README.md - add note on non-interactive mode support #22
There was a problem hiding this comment.
Summary of Changes
Hello @pedrour, 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 enhances the project's documentation by adding a crucial clarification regarding the operational mode of a key security analysis command. This update ensures users are aware of the current interactive-only nature of the command and its future development path, improving user experience and managing expectations.
Highlights
- Documentation Clarity: A note has been added to README.md to inform users that the /security:analyze command is currently designed for interactive use, and that non-interactive support is planned for a future release, linking to the relevant issue.
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 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.
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 inform users that the /security:analyze command is currently limited to interactive sessions. The change is clear and helpful. My review includes one suggestion to improve formatting consistency within the document.
|
|
||
| Important: This report is a first-pass analysis, not a complete security audit. Use in combination with other tools and manual review. | ||
|
|
||
| Note: The /security:analyze command is currently designed for interactive use. Support for non-interactive sessions is planned for a future release (tracked in [issue #20](https://github.com/google-gemini/gemini-cli-security/issues/20)). |
There was a problem hiding this comment.
For consistency with how the command is referenced elsewhere in this file (e.g., on line 23), it's best to wrap the command name /security:analyze in backticks for code formatting. This helps distinguish it as a command and improves readability.
| Note: The /security:analyze command is currently designed for interactive use. Support for non-interactive sessions is planned for a future release (tracked in [issue #20](https://github.com/google-gemini/gemini-cli-security/issues/20)). | |
| Note: The `/security:analyze` command is currently designed for interactive use. Support for non-interactive sessions is planned for a future release (tracked in [issue #20](https://github.com/google-gemini/gemini-cli-security/issues/20)). |
Update README.md - add note on non-interactive mode support #22