Mention replacements for deprecated settings in settings.json#7913
Merged
Mention replacements for deprecated settings in settings.json#7913
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Summary of Changes
Hello @jacob314, 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 user experience by providing clearer guidance when deprecated command-line interface flags are used. It updates the deprecation messages to directly inform users about the equivalent settings available in the settings.json configuration file, ensuring a smoother transition away from outdated CLI options.
Highlights
- Improved Deprecation Messages: Updated deprecation warnings for various CLI flags to explicitly mention their corresponding replacement settings within settings.json, providing clear migration paths for users.
- Telemetry Settings Guidance: Provided specific settings.json paths for deprecated telemetry flags, including telemetry.enabled, telemetry.target, telemetry.otlpEndpoint, telemetry.otlpProtocol, telemetry.logPrompts, and telemetry.outfile.
- UI and Tooling Settings Guidance: Added settings.json replacements for show-memory-usage (now ui.showMemoryUsage) and sandbox-image (now tools.sandbox).
- Proxy and Checkpointing Settings Guidance: Clarified the settings.json equivalents for proxy and checkpointing (now general.checkpointing.enabled).
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. ↩
Contributor
There was a problem hiding this comment.
Code Review
This pull request improves the deprecation messages for several command-line options by pointing to their specific replacements in settings.json. This is a great improvement for user experience. I've found one issue with the proxy option's deprecation message, where it refers to a setting that is not defined in the configuration schema. My review comment provides more details on this.
packages/cli/src/config/config.ts
Outdated
Comment on lines
269
to
272
Contributor
There was a problem hiding this comment.
The deprecation message for the --proxy flag points to a proxy setting in settings.json. However, this setting is not defined in the SETTINGS_SCHEMA in packages/cli/src/config/settingsSchema.ts.
This will be confusing for users as the setting is not documented, and they won't get any editor support (like autocompletion or validation) for it. Using settings.proxy in loadCliConfig will also likely cause a TypeScript compilation error because the proxy property does not exist on the Settings type.
To fix this, the proxy setting should be added to the SETTINGS_SCHEMA as a top-level property. Here is a suggested addition to packages/cli/src/config/settingsSchema.ts:
// In packages/cli/src/config/settingsSchema.ts
export const SETTINGS_SCHEMA = {
proxy: {
type: 'string',
label: 'Proxy Server',
category: 'Advanced',
requiresRestart: true,
default: undefined as string | undefined,
description: 'The proxy server to use for network requests.',
showInDialog: false,
},
// ... other settings
} as const;Please consider adding this schema change to this pull request to ensure consistency and a good user experience. If changing the schema is out of scope for this PR, it might be better to revert the deprecation message for proxy to the generic one for now.
Contributor
Author
There was a problem hiding this comment.
Agree with this @allenhutchison. Should we add this to settingsSchema or remove the text about there being an alternative?
|
Size Change: +11.2 kB (+0.09%) Total Size: 12.5 MB
ℹ️ View Unchanged
|
jacob314
force-pushed
the
jacob314/list_setting_alternative
branch
from
d11da26 to
951a739
Compare
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. |
NTaylorMullen
approved these changes
Sep 7, 2025
allenhutchison
approved these changes
Sep 7, 2025
giraffe-tree
pushed a commit
to giraffe-tree/gemini-cli
that referenced
this pull request
Oct 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TLDR
Mention the setting to use instead of the deprecated config option for all cases where there is a clear 1:1 mapping.