Skip to content

fix(cli): undeprecate --prompt and correct positional query docs#26329

Merged
Adib234 merged 4 commits intomainfrom
fix/issue-19156-prompt-deprecation
May 1, 2026
Merged

fix(cli): undeprecate --prompt and correct positional query docs#26329
Adib234 merged 4 commits intomainfrom
fix/issue-19156-prompt-deprecation

Conversation

@Adib234
Copy link
Copy Markdown
Contributor

@Adib234 Adib234 commented May 1, 2026

Summary

This PR undeprecates the --prompt (-p) flag and corrects documentation for positional arguments to accurately reflect that they run in non-interactive (headless) mode by default.

Details

GitHub issue #19156 highlighted that positional arguments starting with a hyphen (e.g., gemini "-1+2=?") fail because yargs attempts to parse them as options. While --prompt avoids this, the documentation incorrectly marked it as deprecated, discouraging its use.

Additionally, multiple locations in the documentation incorrectly stated that positional queries (e.g., gemini "query") were interactive by default. This PR fixes those descriptions to match the actual implementation.

Changes:

  • Removed deprecation notice for --prompt in docs/reference/configuration.md.
  • Updated docs/cli/cli-reference.md to show gemini "query" as non-interactive.
  • Updated packages/cli/src/config/config.ts help text for the query positional argument.

Related Issues

Fixes #19156

How to Validate

  1. Run gemini --help and verify the query positional argument description is updated.
  2. Run gemini --help and verify --prompt no longer has a deprecation notice.
  3. Observe that gemini "Hello" runs in non-interactive mode (as it already did, but now the docs say so).

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed) - Documentation and help text fix only.
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run

@Adib234 Adib234 requested review from a team as code owners May 1, 2026 14:41
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 addresses documentation inaccuracies and usability concerns regarding the Gemini CLI's interaction modes. By clarifying that positional arguments default to non-interactive execution and removing the deprecation status of the --prompt flag, the changes ensure that users have clear guidance on how to perform non-interactive queries effectively.

Highlights

  • Undeprecation of --prompt: Removed the deprecation notice for the --prompt (-p) flag in the configuration documentation to encourage its continued use.
  • Documentation Correction: Updated CLI reference and help text to accurately reflect that positional queries run in non-interactive mode by default.
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.

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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Size Change: -4 B (0%)

Total Size: 33.9 MB

Filename Size Change
./bundle/chunk-2HF5A2L7.js 0 B -3.43 kB (removed) 🏆
./bundle/chunk-6L7YPSBA.js 0 B -49.2 kB (removed) 🏆
./bundle/chunk-BIPJORYT.js 0 B -657 kB (removed) 🏆
./bundle/chunk-D3SPH3LR.js 0 B -2.72 MB (removed) 🏆
./bundle/chunk-QJJD4TLW.js 0 B -3.8 kB (removed) 🏆
./bundle/chunk-T24QVA6Y.js 0 B -12.5 kB (removed) 🏆
./bundle/chunk-WQXBH5OA.js 0 B -14.7 MB (removed) 🏆
./bundle/chunk-XVU2V5AO.js 0 B -19.5 kB (removed) 🏆
./bundle/core-K72OTWQW.js 0 B -48.2 kB (removed) 🏆
./bundle/devtoolsService-T5LJY75F.js 0 B -28 kB (removed) 🏆
./bundle/gemini-XPRGQ4QD.js 0 B -582 kB (removed) 🏆
./bundle/interactiveCli-GI5F27AH.js 0 B -1.32 MB (removed) 🏆
./bundle/liteRtServerManager-DDLMRFLI.js 0 B -2.11 kB (removed) 🏆
./bundle/oauth2-provider-OMHTS7KG.js 0 B -9.16 kB (removed) 🏆
./bundle/chunk-6OGNOFMN.js 657 kB +657 kB (new file) 🆕
./bundle/chunk-BJXWGWFE.js 3.43 kB +3.43 kB (new file) 🆕
./bundle/chunk-F5IUSJ5W.js 14.7 MB +14.7 MB (new file) 🆕
./bundle/chunk-GMNJLGJA.js 19.5 kB +19.5 kB (new file) 🆕
./bundle/chunk-RMSJXK76.js 3.8 kB +3.8 kB (new file) 🆕
./bundle/chunk-SFVRS7AH.js 12.5 kB +12.5 kB (new file) 🆕
./bundle/chunk-VK35BAF5.js 2.72 MB +2.72 MB (new file) 🆕
./bundle/chunk-WLVOYPLR.js 49.2 kB +49.2 kB (new file) 🆕
./bundle/core-ZM2HPZXZ.js 48.2 kB +48.2 kB (new file) 🆕
./bundle/devtoolsService-MTQXJZQV.js 28 kB +28 kB (new file) 🆕
./bundle/gemini-6YBGV36S.js 582 kB +582 kB (new file) 🆕
./bundle/interactiveCli-M2WFVSJY.js 1.32 MB +1.32 MB (new file) 🆕
./bundle/liteRtServerManager-VT7KDMA5.js 2.11 kB +2.11 kB (new file) 🆕
./bundle/oauth2-provider-ODKSVFQ6.js 9.16 kB +9.16 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./bundle/bundled/third_party/index.js 8 MB 0 B
./bundle/chunk-34MYV7JD.js 2.45 kB 0 B
./bundle/chunk-5AUYMPVF.js 858 B 0 B
./bundle/chunk-5PS3AYFU.js 1.18 kB 0 B
./bundle/chunk-664ZODQF.js 124 kB 0 B
./bundle/chunk-DAHVX5MI.js 206 kB 0 B
./bundle/chunk-IBHWQ36L.js 1.97 MB 0 B
./bundle/chunk-IUUIT4SU.js 56.5 kB 0 B
./bundle/chunk-RJTRUG2J.js 39.8 kB 0 B
./bundle/cleanup-BY42NUY7.js 0 B -932 B (removed) 🏆
./bundle/devtools-36NN55EP.js 696 kB 0 B
./bundle/dist-T73EYRDX.js 356 B 0 B
./bundle/events-XB7DADIJ.js 418 B 0 B
./bundle/examples/hooks/scripts/on-start.js 188 B 0 B
./bundle/examples/mcp-server/example.js 1.43 kB 0 B
./bundle/gemini.js 5.14 kB 0 B
./bundle/getMachineId-bsd-TXG52NKR.js 1.55 kB 0 B
./bundle/getMachineId-darwin-7OE4DDZ6.js 1.55 kB 0 B
./bundle/getMachineId-linux-SHIFKOOX.js 1.34 kB 0 B
./bundle/getMachineId-unsupported-5U5DOEYY.js 1.06 kB 0 B
./bundle/getMachineId-win-6KLLGOI4.js 1.72 kB 0 B
./bundle/memoryDiscovery-KH2QDS2N.js 980 B 0 B
./bundle/multipart-parser-KPBZEGQU.js 11.7 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/client/main.js 222 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/_client-assets.js 229 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/index.js 13.4 kB 0 B
./bundle/node_modules/@google/gemini-cli-devtools/dist/src/types.js 132 B 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B
./bundle/sandbox-macos-strict-open.sb 4.82 kB 0 B
./bundle/sandbox-macos-strict-proxied.sb 5.02 kB 0 B
./bundle/src-QVCVGIUX.js 47 kB 0 B
./bundle/start-K5YWXX2E.js 0 B -652 B (removed) 🏆
./bundle/tree-sitter-7U6MW5PS.js 274 kB 0 B
./bundle/tree-sitter-bash-34ZGLXVX.js 1.84 MB 0 B
./bundle/cleanup-UB7RH4YC.js 932 B +932 B (new file) 🆕
./bundle/start-CAMBPQO6.js 652 B +652 B (new file) 🆕

compressed-size-action

Copy link
Copy Markdown
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 updates the Gemini CLI documentation and configuration to describe positional arguments as non-interactive. However, the code reviewer correctly points out that this change contradicts the actual implementation, which defaults to interactive mode when a TTY is present. The documentation and configuration should be reverted to maintain consistency with the existing CLI behavior.

Comment thread packages/cli/src/config/config.ts Outdated
Comment thread docs/cli/cli-reference.md Outdated
Adib234 and others added 2 commits May 1, 2026 11:01
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@gemini-cli gemini-cli Bot added the area/core Issues related to User Interface, OS Support, Core Functionality label May 1, 2026
@Adib234 Adib234 added this pull request to the merge queue May 1, 2026
Merged via the queue into main with commit 7dea5b4 May 1, 2026
26 of 27 checks passed
@Adib234 Adib234 deleted the fix/issue-19156-prompt-deprecation branch May 1, 2026 19:31
TirthNaik-99 pushed a commit to TirthNaik-99/gemini-cli that referenced this pull request May 4, 2026
…gle-gemini#26329)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
kimjune01 pushed a commit to kimjune01/gemini-cli-claude that referenced this pull request May 6, 2026
…gle-gemini#26329)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core Issues related to User Interface, OS Support, Core Functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: Position argument not allow prompt start with -

2 participants