docs: document missing CLI flags - #29013
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello, 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 improves the CLI documentation by surfacing six configuration flags that were previously missing from the reference table. The changes ensure that users have a complete view of available options, including security-sensitive flags, without requiring them to rely solely on the command-line help output. 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 the 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 counterproductive. 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
|
|
📊 PR Size: size/XS
|
There was a problem hiding this comment.
Code Review
This pull request updates the CLI reference documentation (docs/cli/cli-reference.md) to document several new command-line options, including --policy, --admin-policy, --session-id, --session-file, --raw-output, and --accept-raw-output-risk. There are no review comments, and I have no feedback to provide.
Note: Security Review has been skipped due to the limited scope of the PR.
|
@googlebot I signed it! |
Empty commit; no file changes.
Summary
Adds six flags to the CLI reference table that are registered in
config.tsbut weren't documented:--policy,--admin-policy,--session-id,--session-file,--raw-outputand--accept-raw-output-risk.Details
All six are registered with
.option(...)inpackages/cli/src/config/config.tsand none carryhidden: true, so they already show up ingemini --help— the reference table was just behind.The pair I'd draw attention to is
--raw-output/--accept-raw-output-risk.--raw-outputdisables sanitization of model output, and its own description in the source warns "This can be a security risk if the model output is untrusted";--accept-raw-output-riskexists solely to suppress that warning. I carried the warning into the table rather than describing the flag neutrally, since a reader deciding whether to use it needs that context.--policyand--admin-policymatter because the table already links to the Policy Engine from the--allowed-toolsrow but never mentioned the flags that load policy files.Descriptions are taken from the
descriptionfields inconfig.tsrather than written from scratch, lightly edited for the table (spelling out "for example", and using the table's existing bold-warning style). Rows are placed next to related flags: policy flags after--allowed-tools, session flags after--delete-session, output flags after--output-format. The diff is additive only — no existing row or the column alignment is touched.Related Issues
Fixes #29012
How to Validate
Docs-only, verified by comparison:
.option('<name>', { ... })registration out ofpackages/cli/src/config/config.ts(they span multiple lines, so a plain grep misses some) and diffed the names against the flags in the reference table. That produced exactly these six, plus--acp, which I've handled separately.fake-responses,fake-responses-non-strictandrecord-responsessethidden: true— so all six really do appear in help output.typein the source matches the type column I wrote.A reviewer can confirm with
gemini --help.Pre-Merge Checklist
Platform matrix intentionally unchecked rather than ticked without being exercised — single
.mdtable, no code path.npm run preflightnot run for the same reason; happy to if you'd like it recorded.Note: this edits the same file as #29011 (ACP flag rows) but different rows, so whichever lands second may need a trivial rebase. Happy to combine them if you'd prefer one PR.