refactor: consolidate all flags to use hyphens (deprecate underscore flags) #3541
Conversation
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
![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 @jackwotherspoon, 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 consistency and maintainability of our command-line interface by standardizing flag naming conventions. The primary goal is to transition from underscore-separated flags to hyphen-separated flags, aligning with common CLI best practices. This change involves introducing new flags, deprecating old ones with clear guidance, and updating the underlying argument parsing to ensure backward compatibility during the transition phase.
Highlights
- CLI Flag Standardization: I've initiated a refactoring effort to standardize all CLI flags to use hyphens (
-) instead of underscores (_) for improved consistency across the application's command-line interface. - Deprecation Strategy: New hyphenated flags (e.g.,
--all-files,--show-memory-usage) have been introduced. The old underscore-based flags (--all_files,--show_memory_usage) are now deprecated and will display a warning message recommending the use of their hyphenated counterparts. These deprecated flags will be removed in future releases. - Internal Argument Handling: The internal argument parsing logic has been updated to recognize and prioritize the new hyphenated flag names. For a smooth transition, the system will continue to accept and correctly interpret the deprecated underscore flags during this interim period.
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 refactors the CLI flags to consistently use hyphens over underscores, deprecating the old underscore-based flags. The changes in config.ts and sandboxConfig.ts are well-implemented, correctly using yargs to manage the new, old, and deprecated flags. The logic for handling both old and new flags ensures backward compatibility.
To complete this refactoring, I've identified two areas that need attention, which I consider high-priority for ensuring the quality and maintainability of this change:
-
Documentation (
highseverity): The command-line arguments documentation indocs/cli/configuration.mdneeds to be updated to reflect these flag changes. It currently lists the old, deprecated flags (e.g.,--all_files,--show_memory_usage) and should be updated to feature the new hyphenated flags as the primary options. -
Testing (
highseverity): The unit tests inpackages/cli/src/config/config.test.tsshould be updated. The existing tests for flags likeshow_memory_usageonly cover the old, deprecated version. New tests are needed to verify the behavior of the new hyphenated flags and the precedence logic to prevent future regressions.
Addressing these points will make this a complete and robust change.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x' artifact from the main CI run. |
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-24.x' artifact from the main CI run. |
gemini-cli
bot
added
kind/enhancement
jerop
reviewed
Jul 8, 2025
NTaylorMullen
previously approved these changes
Jul 8, 2025
| - Enables debug mode for this session, providing more verbose output. | ||
| - **`--all_files`** (**`-a`**): |
There was a problem hiding this comment.
lmao we were monsters
|
@jackwotherspoon can you resolve the conflicts then we can merge this |
NTaylorMullen
approved these changes
Jul 8, 2025
JunYang-tes
pushed a commit
to JunYang-tes/gemini-cli.nvim
that referenced
this pull request
Jul 12, 2025
davenportjw
pushed a commit
to davenportjw/gemini-cli
that referenced
this pull request
Jul 24, 2025
involvex
pushed a commit
to involvex/gemini-cli
that referenced
this pull request
Sep 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Consolidate CLI flags to use hyphens (
-) over underscores (_) for consistency.To remove deprecated flags in a few releases.
Dive Deeper
Add new flags using hyphens, moved aliases to hyphen flags, deprecated old flags (to be removed in a couple releases)
Old flags will recommend usage of new flag with hyphen.
Reviewer Test Plan
Running
--helpon feature branch:Testing Matrix
Linked issues / bugs
Related to #3471