Skip to content

documentiong ensures ripgrep#21298

Merged
gsquared94 merged 2 commits intogoogle-gemini:mainfrom
Jatin24062005:document_ripGrep.ts
Mar 6, 2026
Merged

documentiong ensures ripgrep#21298
gsquared94 merged 2 commits intogoogle-gemini:mainfrom
Jatin24062005:document_ripGrep.ts

Conversation

@Jatin24062005
Copy link
Copy Markdown
Contributor

@Jatin24062005 Jatin24062005 commented Mar 5, 2026

Summary

This PR documents the current ripgrep selection behavior in Gemini CLI.

The CLI intentionally uses a managed ripgrep binary and does not yet prefer a system-installed rg, pending checksum verification and internalization of get-ripgrep.

No runtime behavior is changed.

Related Issues

#11438

How to Validate

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 clarity of the Gemini CLI's ripgrep binary management by adding detailed documentation. It explains the current strategy of preferring a managed ripgrep binary and the reasons for not utilizing system-installed versions, without altering any existing operational logic. The primary goal is to provide transparency regarding the ripgrep selection mechanism for developers.

Highlights

  • Documentation: Added comprehensive JSDoc comments to the ensureRipgrepAvailable function, clarifying the current ripgrep binary selection behavior within the Gemini CLI.
  • Behavior Clarification: Explicitly documented that the CLI intentionally prefers a managed ripgrep binary over system-installed versions, outlining the technical reasons and dependencies blocking a change to prefer system-installed rg.
  • No Functional Change: Confirmed that this pull request introduces no changes to the runtime behavior or functionality of the ripgrep acquisition process.
Changelog
  • packages/core/src/tools/ripGrep.ts
    • Added JSDoc comments to the ensureRipgrepAvailable function to document the ripgrep binary selection logic.
Activity
  • No human activity has occurred on this pull request yet.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 adds documentation to the ensureRipgrepAvailable function, clarifying the behavior of ripgrep binary selection. The new comment correctly states that the CLI prefers a managed binary over a system-installed one and explains the rationale. The change is purely documentary and introduces no runtime modifications. The PR title contains a typo ('documentiong') and does not adhere to the Conventional Commits standard specified in the repository's style guide; it could be improved to docs(core): document ripgrep selection behavior.

@gemini-cli gemini-cli bot added priority/p3 Backlog - a good idea but not currently a priority. area/core Issues related to User Interface, OS Support, Core Functionality help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! labels Mar 5, 2026
@gsquared94 gsquared94 enabled auto-merge March 6, 2026 05:51
@gsquared94 gsquared94 added this pull request to the merge queue Mar 6, 2026
Merged via the queue into google-gemini:main with commit 35c1999 Mar 6, 2026
27 checks passed
@chinovelez022-ctrl
Copy link
Copy Markdown

chinovelez022-ctrl commented Mar 6, 2026 via email

struckoff pushed a commit to struckoff/gemini-cli that referenced this pull request Mar 6, 2026
Co-authored-by: Gaurav <39389231+gsquared94@users.noreply.github.com>
kunal-10-cloud pushed a commit to kunal-10-cloud/gemini-cli that referenced this pull request Mar 12, 2026
Co-authored-by: Gaurav <39389231+gsquared94@users.noreply.github.com>
liamhelmer pushed a commit to badal-io/gemini-cli that referenced this pull request Mar 12, 2026
Co-authored-by: Gaurav <39389231+gsquared94@users.noreply.github.com>
yashodipmore pushed a commit to yashodipmore/geemi-cli that referenced this pull request Mar 21, 2026
Co-authored-by: Gaurav <39389231+gsquared94@users.noreply.github.com>
SUNDRAM07 pushed a commit to SUNDRAM07/gemini-cli that referenced this pull request Mar 30, 2026
Co-authored-by: Gaurav <39389231+gsquared94@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Issues related to User Interface, OS Support, Core Functionality help wanted We will accept PRs from all issues marked as "help wanted". Thanks for your support! priority/p3 Backlog - a good idea but not currently a priority.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants