docs(cli): add System Prompt Override (GEMINI_SYSTEM_MD)
TLDR
Adds documentation for GEMINI_SYSTEM_MD to docs/cli
Linked issues / bugs
Closes #9500
Summary of Changes
Hello @ashmod, I'm Gemini Code Assist[^1]! 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 and documents a powerful new feature for the Gemini CLI: the ability to override the default system prompt using a custom Markdown file via the GEMINI_SYSTEM_MD environment variable. This enhancement provides advanced users with greater control over the CLI's behavior and persona, allowing for highly customized, project-specific instructions. Additionally, it documents a mechanism (GEMINI_WRITE_SYSTEM_MD) to export the default prompt, facilitating easier customization.
Highlights
- System Prompt Override (
GEMINI_SYSTEM_MD): Documentation for theGEMINI_SYSTEM_MDenvironment variable has been added, enabling users to replace the Gemini CLI's built-in system prompt with content from a custom Markdown file. - Exporting System Prompt (
GEMINI_WRITE_SYSTEM_MD): TheGEMINI_WRITE_SYSTEM_MDenvironment variable is now documented, allowing users to export the current built-in system prompt to a file for review or modification. - Documentation Updates: New and updated documentation files (
docs/core/system-prompt.md,docs/cli/configuration.md,docs/core/index.md,docs/index.md) have been added to comprehensively cover the system prompt override feature.
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 :thumbsup: and :thumbsdown: 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.
[^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.
Hi there! This is great. I made a few tiny comments from a documentation perspective, mostly because some documents have changed places. Will still need review by eng.
Thanks for the review! I've addressed all the changes, lmk if I missed anything or if anything else needs to be modified.
@jkcinouye I've updated this to remove conflicts with the base. Could you please check if everything is good to go?
Hi there! I'm sorry for letting this slip - bear with me a bit. There's just one minor change, this would really go into /cli/ not /core/ (core is mostly for under the hood engine work, cli is for anything the user would interface with). Do you think you could update that? Otherwise I think this is GTG.
Hi, the new docs now point to cli/
Fixed the lint/broken link. CI should pass now.