Skip to content

docs: Update documentation for deprecated -p/--prompt flags#14681

Closed
wanglc02 wants to merge 8 commits intogoogle-gemini:mainfrom
wanglc02:remove-p
Closed

docs: Update documentation for deprecated -p/--prompt flags#14681
wanglc02 wants to merge 8 commits intogoogle-gemini:mainfrom
wanglc02:remove-p

Conversation

@wanglc02
Copy link
Contributor

@wanglc02 wanglc02 commented Dec 7, 2025

Summary

This PR updates the documentation to remove all references to the deprecated -p and --prompt flags, replacing them with the current positional argument syntax for non-interactive prompts.

Details

The -p and --prompt flags 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 the docs folder to use positional arguments (e.g., gemini "your prompt").

How to Validate

  1. Check the "Files changed" in this PR.
  2. Verify that there are no more instances of -p or --prompt being used to pass prompts in the documentation files.
  3. Confirm that the examples now use the correct positional argument syntax (e.g., gemini "some prompt").
  4. The affected files include docs/cli/index.md, docs/cli/sandbox.md, docs/get-started/installation.md, and the legacy docs/get-started/configuration-v1.md.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@wanglc02 wanglc02 requested a review from a team as a code owner December 7, 2025 12:41
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • Documentation Update: All documentation has been updated to remove references to the deprecated -p and --prompt flags for non-interactive prompts.
  • Positional Arguments: The documentation now consistently uses positional arguments (e.g., gemini "your prompt") for passing prompts in non-interactive mode.
  • CLI Usage String Refinement: The CLI's internal usage message has been updated to reflect the new positional argument syntax for non-interactive mode.
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 👍 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

  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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@gemini-cli gemini-cli bot added the status/need-issue Pull requests that need to have an associated issue. label Jan 7, 2026
Copy link
Contributor

@jkcinouye jkcinouye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for docs.

Fixing conflict - we have deleted deployment.md and replaced it with installation.md.
@jkcinouye jkcinouye enabled auto-merge January 12, 2026 18:16
@scidomino
Copy link
Collaborator

@wanglc02 Fix the lint errors and we can merge this, I think.

@bdmorgan
Copy link
Collaborator

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!

@sehoon38 sehoon38 requested a review from a team as a code owner January 21, 2026 04:12
@gemini-cli
Copy link
Contributor

gemini-cli bot commented Jan 24, 2026

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:
Add a keyword followed by the issue number (e.g., Fixes #123) in the description of your pull request. For more details, see the GitHub Documentation.

Thank you for your understanding and for being a part of our community!

@gemini-cli gemini-cli bot closed this Jan 24, 2026
auto-merge was automatically disabled January 24, 2026 16:49

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants