-
Notifications
You must be signed in to change notification settings - Fork 0
add CLI support for alerts summaries scans and following over time #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add CLI support for alerts summaries scans and following over time #130
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @epalhares-tenchi, 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!
I've introduced two new CLI commands to align with recent additions to the SDK, enabling users to fetch alert summaries for scans and track following alerts over time directly from the command line. This update enhances the CLI's capabilities by exposing more data retrieval functionalities previously only available via the SDK.
Highlights
- New CLI Command: get_alerts_summaries_scans: I've added a new CLI command,
alerts_scans, which wraps theclient.get_alerts_summaries_scansSDK call. This command supportsorganization-id(required),scan-target-ids(optional list), anddays(optional, defaulting to 7). - Updated CLI Command: get_following_alerts_over_time: I've updated the existing
summary_following_alerts_over_timecommand to correctly callclient.get_following_alerts_over_timeinstead ofclient.get_alerts_over_time. This command continues to acceptorganization-id,following-ids,severities, anddates. - SDK Version Bump: The
zanshinsdkdependency has been bumped from version2.1.9to2.1.10across the project's dependency management files (pyproject.tomlandpoetry.lock).
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 or fill out our survey 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces two new CLI commands, get_alerts_summaries_scans and get_following_alerts_over_time, by updating the zanshinsdk dependency and adding corresponding functions in src/bin/summary.py. The changes are well-structured and align with the existing code. I have one suggestion to improve the clarity of a help message for one of the new command's options.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Description
This PR adds two new commands to the CLI, reflecting recent additions to the SDK:
get_alerts_summaries_scansPOST /alerts/summaries/scans--organization-id(required)--scan-target-ids(optional, list)--days(optional, default = 7)get_following_alerts_over_timePOST /alerts/summaries/following/resolvedovertime--organization-id(required)--following-ids(optional, list)--severities(optional, list)--dates(optional, list of YYYY-MM-DD)Both commands support JSON output and follow the SDK structure.
This update is part of the ongoing SDK/CLI sync based on the