docs: Update documentation for deprecated -p/--prompt flags#14681
docs: Update documentation for deprecated -p/--prompt flags#14681wanglc02 wants to merge 8 commits intogoogle-gemini:mainfrom
Conversation
Updated the documentation to reflect changes in command usage for headless mode, replacing the use of the '--prompt' flag with positional arguments.
Summary of ChangesHello @wanglc02, 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 enhancing the clarity and accuracy of the CLI documentation by aligning it with recent changes in how prompts are handled. By removing deprecated flag references and emphasizing positional arguments, the aim is to prevent user confusion and streamline the learning curve for non-interactive CLI usage. 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 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 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
|
There was a problem hiding this comment.
Code Review
This pull request effectively updates the documentation to replace the deprecated -p/--prompt flags with the new positional argument syntax. The changes are consistent across all modified files, including the README, various documentation pages, and the CLI's usage text. I've found one minor inconsistency in the documentation I'd like to point out for improvement.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Fixing conflict - we have deleted deployment.md and replaced it with installation.md.
|
@wanglc02 Fix the lint errors and we can merge this, I think. |
|
Hi @wanglc02, 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! |
|
Hi there! Thank you for your contribution to Gemini CLI. To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md. This pull request is being closed because it is not currently linked to an issue. You can easily reopen this PR once you have linked it to an issue. How to link an issue: Thank you for your understanding and for being a part of our community! |
Pull request was closed
Summary
This PR updates the documentation to remove all references to the deprecated
-pand--promptflags, replacing them with the current positional argument syntax for non-interactive prompts.Details
The
-pand--promptflags have been deprecated in the CLI. This change ensures our documentation is consistent with the current implementation and avoids confusion for users. I have updated all examples and descriptions across thedocsfolder to use positional arguments (e.g.,gemini "your prompt").How to Validate
-por--promptbeing used to pass prompts in the documentation files.gemini "some prompt").docs/cli/index.md,docs/cli/sandbox.md,docs/get-started/installation.md, and the legacydocs/get-started/configuration-v1.md.Pre-Merge Checklist