Skip to content

docs(core): add automated gemma setup guide#26233

Merged
Samee24 merged 3 commits intomainfrom
sameez/gemma-docs
Apr 29, 2026
Merged

docs(core): add automated gemma setup guide#26233
Samee24 merged 3 commits intomainfrom
sameez/gemma-docs

Conversation

@Samee24
Copy link
Copy Markdown
Contributor

@Samee24 Samee24 commented Apr 29, 2026

Summary

This PR adds the new automated setup documentation for the gemini gemma setup command, and points the existing documentation towards this new guide. The automated command is now the recommended path for users to enable local model routing.

Details

  • Added docs/core/gemma-setup.md: Comprehensive setup guide covering the automated command, verification steps, and how it works under the hood. Includes the experimental warning callout.
  • Updated docs/core/local-model-routing.md: Retitled to reflect it is now the Manual path, maintaining it as a fallback for advanced/firewalled environments. Added a recommendation banner pointing to the new automated setup guide.
  • Updated docs/cli/model-routing.md & docs/core/index.md: Updated links from the old manual path to the new automated setup guide.

Related Issues

N/A

How to Validate

  1. Review the formatting in docs/core/gemma-setup.md to ensure callouts are correctly utilized.
  2. Verify that links from docs/cli/model-routing.md and docs/core/index.md appropriately resolve to the new gemma-setup.md.
  3. Check the Manual setup page (docs/core/local-model-routing.md) visually to confirm the callouts are clear.

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:

@Samee24 Samee24 requested review from a team as code owners April 29, 2026 22:32
@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 introduces a streamlined onboarding experience for local model routing by documenting the new automated setup command. It shifts the primary documentation focus toward this automated approach while preserving the manual configuration steps as a fallback for restricted environments.

Highlights

  • New Automated Setup Guide: Added a comprehensive documentation file for the new automated gemini gemma setup command.
  • Documentation Reorganization: Updated existing documentation to point to the new automated setup as the recommended path, while retaining the manual setup guide for advanced use cases.
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.

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.

@gemini-cli
Copy link
Copy Markdown
Contributor

gemini-cli Bot commented Apr 29, 2026

Hi @Samee24, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

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 introduces documentation for the new automated local model routing setup using the gemini gemma setup command. It includes a new guide (docs/core/gemma-setup.md) and updates existing documentation to prioritize the automated setup over manual configuration. I have no feedback to provide.

Note: Security Review has been skipped due to the limited scope of the PR.

@gemini-cli gemini-cli Bot added the status/need-issue Pull requests that need to have an associated issue. label Apr 29, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

Size Change: -4 B (0%)

Total Size: 33.9 MB

Filename Size Change
./bundle/chunk-4J75CK26.js 0 B -14.7 MB (removed) 🏆
./bundle/chunk-5HWDHS7U.js 0 B -3.43 kB (removed) 🏆
./bundle/chunk-BN4GJ5PN.js 0 B -19.5 kB (removed) 🏆
./bundle/chunk-HZD6ICI2.js 0 B -2.72 MB (removed) 🏆
./bundle/chunk-LTJA22GD.js 0 B -12.6 kB (removed) 🏆
./bundle/chunk-RR7VWYUG.js 0 B -655 kB (removed) 🏆
./bundle/chunk-VQ3Z3CLF.js 0 B -3.8 kB (removed) 🏆
./bundle/chunk-ZW6ZBLYY.js 0 B -49.2 kB (removed) 🏆
./bundle/core-SZWLLU56.js 0 B -48.2 kB (removed) 🏆
./bundle/devtoolsService-SVA6HTB2.js 0 B -28 kB (removed) 🏆
./bundle/gemini-BYR4NDDO.js 0 B -577 kB (removed) 🏆
./bundle/interactiveCli-S3ZBBYPB.js 0 B -1.31 MB (removed) 🏆
./bundle/liteRtServerManager-IETE4ZMD.js 0 B -2.11 kB (removed) 🏆
./bundle/oauth2-provider-IG5O6TH4.js 0 B -9.16 kB (removed) 🏆
./bundle/chunk-AARZR3NO.js 14.7 MB +14.7 MB (new file) 🆕
./bundle/chunk-DEDARAOF.js 12.6 kB +12.6 kB (new file) 🆕
./bundle/chunk-DICHOWAV.js 3.43 kB +3.43 kB (new file) 🆕
./bundle/chunk-DUB7HDF4.js 2.72 MB +2.72 MB (new file) 🆕
./bundle/chunk-KGNVOIAT.js 655 kB +655 kB (new file) 🆕
./bundle/chunk-N3CRPNGE.js 19.5 kB +19.5 kB (new file) 🆕
./bundle/chunk-N5GCZ5AZ.js 3.8 kB +3.8 kB (new file) 🆕
./bundle/chunk-RINHGEQT.js 49.2 kB +49.2 kB (new file) 🆕
./bundle/core-UB7PIWUY.js 48.2 kB +48.2 kB (new file) 🆕
./bundle/devtoolsService-ZFHRPCRB.js 28 kB +28 kB (new file) 🆕
./bundle/gemini-74F65IBS.js 577 kB +577 kB (new file) 🆕
./bundle/interactiveCli-ZMDFYCRJ.js 1.31 MB +1.31 MB (new file) 🆕
./bundle/liteRtServerManager-WWSQIQWF.js 2.11 kB +2.11 kB (new file) 🆕
./bundle/oauth2-provider-EICA2WED.js 9.16 kB +9.16 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./bundle/bundled/third_party/index.js 8 MB 0 B
./bundle/chunk-34MYV7JD.js 2.45 kB 0 B
./bundle/chunk-5AUYMPVF.js 858 B 0 B
./bundle/chunk-5PS3AYFU.js 1.18 kB 0 B
./bundle/chunk-664ZODQF.js 124 kB 0 B
./bundle/chunk-DAHVX5MI.js 206 kB 0 B
./bundle/chunk-IUUIT4SU.js 56.5 kB 0 B
./bundle/chunk-RJTRUG2J.js 39.8 kB 0 B
./bundle/chunk-XRLFHCHC.js 1.97 MB 0 B
./bundle/cleanup-6ZLECNSB.js 0 B -932 B (removed) 🏆
./bundle/devtools-36NN55EP.js 696 kB 0 B
./bundle/dist-T73EYRDX.js 356 B 0 B
./bundle/events-XB7DADIJ.js 418 B 0 B
./bundle/examples/hooks/scripts/on-start.js 188 B 0 B
./bundle/examples/mcp-server/example.js 1.43 kB 0 B
./bundle/gemini.js 5.1 kB 0 B
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB 0 B
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB 0 B
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB 0 B
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB 0 B
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB 0 B
./bundle/memoryDiscovery-FN3IAPBT.js 980 B 0 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 222 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 229 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 13.4 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B
./bundle/src-QVCVGIUX.js 47 kB 0 B
./bundle/start-E4536TWT.js 0 B -652 B (removed) 🏆
./bundle/tree-sitter-7U6MW5PS.js 274 kB 0 B
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB 0 B
./bundle/cleanup-Y4GZ2WIP.js 932 B +932 B (new file) 🆕
./bundle/start-Q6TIXJP5.js 652 B +652 B (new file) 🆕

compressed-size-action

Copy link
Copy Markdown
Contributor

@Abhijit-2592 Abhijit-2592 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Samee24 Samee24 enabled auto-merge April 29, 2026 22:59
@Samee24 Samee24 added this pull request to the merge queue Apr 29, 2026
Merged via the queue into main with commit 8cec567 Apr 29, 2026
26 of 27 checks passed
@Samee24 Samee24 deleted the sameez/gemma-docs branch April 29, 2026 23:21
TirthNaik-99 pushed a commit to TirthNaik-99/gemini-cli that referenced this pull request May 4, 2026
Co-authored-by: Samee Zahid <sameez@google.com>
kimjune01 pushed a commit to kimjune01/gemini-cli-claude that referenced this pull request May 6, 2026
Co-authored-by: Samee Zahid <sameez@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants