-
Notifications
You must be signed in to change notification settings - Fork 10.1k
feat(cli): deprecate redundant CLI flags #7360
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
Conversation
This commit marks a number of CLI flags as deprecated, as part of the effort to streamline the CLI interface. The deprecated flags are: --telemetry --telemetry-target --telemetry-otlp-endpoint --telemetry-otlp-protocol --telemetry-log-prompts --telemetry-outfile --show-memory-usage --sandbox-image --proxy --checkpointing --all-files This is the first phase of streamlining the Gemini CLI. Fixes #6706
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 @allenhutchison, 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 initiates the first phase of streamlining the CLI interface by marking several command-line flags as deprecated. The primary goal is to reduce redundancy and simplify the user experience by shifting configuration of these features to the settings.json file, preparing for their eventual removal.
Highlights
- CLI Flag Deprecation: This PR deprecates a set of redundant CLI flags, including various telemetry-related flags (--telemetry, --telemetry-target, --telemetry-otlp-endpoint, --telemetry-otlp-protocol, --telemetry-log-prompts, --telemetry-outfile), as well as --show-memory-usage, --sandbox-image, --proxy, --checkpointing, and --all-files. This is part of an ongoing effort to streamline the CLI interface, with users now encouraged to configure these settings via settings.json.
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.
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 deprecates several CLI flags. The implementation uses a long chain of deprecateOption calls, which introduces significant code duplication. My review includes a suggestion to refactor this for improved maintainability by iterating over a list of flags, which would make the code cleaner and easier to manage.
| .deprecateOption( | ||
| 'telemetry', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'telemetry-target', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'telemetry-otlp-endpoint', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'telemetry-otlp-protocol', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'telemetry-log-prompts', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'telemetry-outfile', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'show-memory-usage', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'sandbox-image', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'proxy', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'checkpointing', | ||
| 'Use settings.json instead. This flag will be removed in a future version.', | ||
| ) | ||
| .deprecateOption( | ||
| 'all-files', | ||
| 'Use @ includes in the application instead. This flag will be removed in a future version.', | ||
| ) |
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.
The long chain of deprecateOption calls with nearly identical messages is highly repetitive and can be hard to maintain. Consider refactoring this to reduce code duplication.
For example, you could group the flags into an array and iterate over them. This would require changing the fluent chain into a block with statements, which would make the code more readable and easier to modify in the future:
// ...
.option('screen-reader', { ... });
const flagsToDeprecate = [
'telemetry',
'telemetry-target',
'telemetry-otlp-endpoint',
'telemetry-otlp-protocol',
'telemetry-log-prompts',
'telemetry-outfile',
'show-memory-usage',
'sandbox-image',
'proxy',
'checkpointing',
];
for (const flag of flagsToDeprecate) {
yargsInstance.deprecateOption(
flag,
'Use settings.json instead. This flag will be removed in a future version.'
);
}
yargsInstance.deprecateOption(
'all-files',
'Use @ includes in the application instead. This flag will be removed in a future version.'
);
yargsInstance.check((argv) => {
// ...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.
This is only a temporary state for the next few releases. It's more straightforward to leave as is.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
jacob314
left a comment
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.
(cherry picked from commit 648ab84)
This commit marks a number of CLI flags as deprecated, as part of the effort to streamline the CLI interface.
The deprecated flags are:
--telemetry
--telemetry-target
--telemetry-otlp-endpoint
--telemetry-otlp-protocol
--telemetry-log-prompts
--telemetry-outfile
--show-memory-usage
--sandbox-image
--proxy
--checkpointing
--all-files
This is the first phase of streamlining the Gemini CLI.
Part of #6706