Add enterprise settings docs#6076
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @chrstnb, 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 comprehensive documentation for configuring the Gemini CLI in enterprise environments. It outlines best practices for system administrators to manage settings, enforce security policies, and ensure consistent user experiences through centralized settings.json files.
Highlights
- Enterprise Configuration Documentation: A new enterprise.md document has been added, providing detailed guidance on deploying and managing Gemini CLI in corporate settings.
- Centralized System Settings: The documentation emphasizes the use of a system-wide settings.json file for baseline configuration, overriding user or project-level settings.
- Tool Access Control: It explains how to restrict tool access using coreTools (allowlisting) and excludeTools (blocklisting), with a strong recommendation for allowlisting for enhanced security.
- Secure MCP Server Management: Guidance is provided on securely managing custom Model-Context Protocol (MCP) servers, highlighting the importance of defining canonical server configurations and using allowMCPServers for allowlisting.
- Security and Compliance Features: The new document also covers enforcing sandboxing, configuring network access via proxy, and setting up telemetry for auditing purposes, including a note on sensitive data logging.
- Documentation Link Updates: Existing documentation files (configuration.md and index.md) have been updated to include links to the new enterprise configuration guide.
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 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
-
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 adds comprehensive documentation for enterprise configurations of the Gemini CLI. The new enterprise.md file is well-structured and covers critical security topics like tool access control, custom tool management, and sandboxing. My main feedback is to improve the consistency and correctness of comments within the JSON configuration examples to avoid potential confusion for administrators implementing these settings.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for enterprise configurations of the Gemini CLI. The new enterprise.md file is well-structured and provides valuable security guidance for administrators. However, several JSON examples in the new documentation contain syntax errors or use invalid patterns, such as duplicate keys. I've provided suggestions to correct these examples to ensure they are valid and clear for users.
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for enterprise users, clearly outlining security patterns and best practices for deploying Gemini CLI in a managed environment. The new enterprise.md page is well-structured and the security advice, particularly around allowlisting tools and MCP servers, is excellent. However, the new documentation introduces a contradiction with the existing configuration.md file. The security notes for allowMCPServers in configuration.md are now outdated and misleading, as they downplay the effectiveness of the very security mechanism that enterprise.md promotes as a critical control. This should be addressed to avoid confusion for administrators and to ensure the security guidance is consistent across the documentation.
TLDR
Introduce
enterprise.mdwith a sample configuration and other information that enterprises might use to standardize/enforce their users' experience with gemini.This addresses frequently-asked questions around how to set up e.g., MCP servers.
Interested in feedback from folks. This was largely gemini-generated, but I from what I can tell everything it's saying is true to the codebase/implementation :)
Dive Deeper
Reviewer Test Plan
Testing Matrix
Linked issues / bugs