docs(get-started): add Windows PowerShell troubleshooting for gemini command - #28447
docs(get-started): add Windows PowerShell troubleshooting for gemini command#28447dipeshpandit12 wants to merge 2 commits into
Conversation
…command Document the two common reasons the 'gemini' command fails in PowerShell after a global npm install: the npm global bin directory not being on PATH, and PowerShell's Restricted execution policy blocking the gemini.ps1 shim. Add a pointer from the installation page to the troubleshooting guide.
Summary of ChangesHello, 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 addresses documentation gaps for Windows users installing the Gemini CLI. It provides clear guidance on resolving common issues related to PowerShell execution policies and environment PATH configuration, ensuring that users can successfully run the CLI after a global npm installation. Highlights
Using Gemini Code AssistThe 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
Customization To customize the 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 Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. 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
|
|
📊 PR Size: size/S
|
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to address common installation and execution issues on Windows. Specifically, it adds a troubleshooting note to the installation guide for Windows PowerShell users and provides detailed instructions in the troubleshooting guide on how to resolve PATH issues and PowerShell execution policy restrictions (e.g., using 'Set-ExecutionPolicy' or running via 'npx'). No review comments were provided, and I have no feedback to provide.
|
@googlebot I signed it! |
gemini-cli
Bot
added
priority/p2
Minor whitespace touch to force CLA Assistant to re-run on this branch.
|
Hi team, just following up on this PR! The CLA is signed and I believe it's ready for review. Let me know if you need anything else from my end to help move this forward. |
|
Hi there! Thank you for your interest in contributing to Gemini CLI. To ensure we maintain high code quality and focus on our prioritized roadmap, we only guarantee review and consideration of pull requests for issues that are explicitly labeled as 'help wanted'. This PR will be closed in 7 days if it remains without that designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding. |
|
This pull request is being closed as it has been open for 14 days without a 'help wanted' designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding. |
1 participant
Summary
Users installing Gemini CLI on Windows report that the
geminicommand fails torun in PowerShell after a global npm install. The installation docs list
PowerShell as a supported shell but give no Windows-specific guidance, and the
troubleshooting guide did not cover the PowerShell execution-policy error. This
PR documents the fix so affected users are unblocked.
Details
This is an environment/documentation gap, not a packaging bug: the published
bundle/gemini.jsretains a valid#!/usr/bin/env nodeshebang and the packageis
"type": "module", so npm's Windows shims are generated correctly.The detailed fix lives once in the troubleshooting guide (the canonical location)
to avoid duplication; the installation page carries a short pointer to it so the
user who lands there finds it. Two failure modes are covered: the npm global bin
directory not being on
PATH, and PowerShell's defaultRestrictedexecutionpolicy blocking the
gemini.ps1shim.Related Issues
Fixes #28314
How to Validate
docs/get-started/installation.mdxand confirm the PowerShell noterenders under "Run Gemini CLI" and links to the troubleshooting guide.
docs/resources/troubleshooting.mdand confirm the newgemini.ps1 ... running scripts is disabledentry and the WindowsPATHnote.npm run format(orprettier --check) —.mdis Prettier-clean;.mdxis excluded per.prettierignore.Pre-Merge Checklist
build artifacts or runtime behavior changed