Fix and improve Gemini CLI troubleshooting.md doc #2734
Conversation
8bitmp3
commented
Jun 30, 2025
8bitmp3
commented
- Nit fixes to the Troubleshooting doc from the tech writing perspective.
- As the doc gets larger over time, there's a small ToC in the beginning.
![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 @8bitmp3, 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 improving the troubleshooting documentation for the Gemini CLI. It includes minor fixes, a table of contents, and expanded explanations for common issues and solutions, making it easier for users to diagnose and resolve problems they may encounter.
Highlights
- Troubleshooting Guide Improvements: The troubleshooting guide has been updated with minor fixes and a table of contents to improve readability and navigation.
- FAQ Updates: The FAQ section has been expanded with more detailed answers and clarifications, including information about configuration file locations and token usage.
- Error Message Solutions: Solutions for common error messages have been updated and clarified, including steps for resolving 'Command not found' and 'MODULE_NOT_FOUND' errors.
- CI Environment Handling: The guide now includes specific information on how to handle CI environments where the CLI might not run in interactive mode due to environment variables.
- Debugging Tips: Added debugging tips and guidance on tool issues and pre-flight checks, as well as a pointer to the GitHub issue tracker.
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 significantly improves the troubleshooting documentation by adding a table of contents, clarifying existing sections, and restructuring information for better readability. The changes make the guide more user-friendly and effective for resolving common issues. The added details and improved phrasing are excellent. I have no high or critical severity feedback on these changes.
|
@NTaylorMullen @cperry-goog @KeijiBranshi PTAL TODO: Fix the build and lint issue |
|
@markmcd PTAL (if you are here) |
markmcd
left a comment
markmcd
left a comment
There was a problem hiding this comment.
Couple minor nits but otherwise thanks!
docs/troubleshooting.md
Outdated
| - **Solution:** | ||
| 1. Run `npm install` to ensure all dependencies are present. | ||
| 2. Run `npm run build` to compile the project. | ||
| 3. Verify that the build completed successfully with `gemini --version`. |
There was a problem hiding this comment.
To avoid hitting "not installed" or not on path, can you make this npm run start
|
@8bitmp3 looks like there may be a few merge conflicts + you may need to run |
|
thanks @NTaylorMullen I ran |
|
@markmcd PTAL |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Co-authored-by: Sandy Tao <[email protected]>
Co-authored-by: Sandy Tao <[email protected]>
Co-authored-by: Sandy Tao <[email protected]>
Co-authored-by: Sandy Tao <[email protected]>
Co-authored-by: Sandy Tao <[email protected]>
4 participants
