docs: fix ACP flags in CLI reference - #29011
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 updates the CLI reference documentation to accurately reflect the current state of ACP (Agent Client Protocol) flags. It removes obsolete entries, introduces missing documentation for active flags, and corrects terminology to ensure consistency across the project's documentation. 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 to reflect changes in the ACP (Agent Client Protocol) flags. Specifically, the --experimental-acp flag has been deprecated in favor of the new --acp flag, and the --experimental-zed-integration flag has been removed. There are no review comments, so 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
Fixes three problems in two adjacent rows of the CLI reference flags table: a flag that no longer exists, a wrong expansion of the ACP acronym, and the current
--acpflag being missing while the deprecated one isn't labelled as deprecated.Details
Removed
--experimental-zed-integration. It isn't implemented —experimental-zed-integration/experimentalZedIntegrationappears nowhere underpackages/; the only occurrence in the repo was that documentation row.Added
--acp.packages/cli/src/config/config.tsregisters it as "Starts the agent in ACP mode", anddocs/cli/acp-mode.mdalready instructs people to rungemini --acp— but the reference table never mentioned it.Marked
--experimental-acpas deprecated. Its own description in the source says "(deprecated, use --acp instead)", which the table didn't reflect. I followed the phrasing the table already uses for--yolo("Deprecated. ... UseXinstead.") so it reads consistently.Fixed the acronym. The row expanded ACP as "Agent Code Pilot". It's the Agent Client Protocol — the first line of
docs/cli/acp-mode.mdsays so, and that's the name of the open protocol the mode implements.The table's column padding is unchanged, so the diff is two rows out, two rows in.
Related Issues
Fixes #29010
How to Validate
Docs-only, verified against the source:
grep -rn "experimental-zed-integration\|experimentalZedIntegration" packages/— no results, confirming the removed flag isn't implemented.grep -n "\.option('acp'" packages/cli/src/config/config.ts— shows--acpwith description "Starts the agent in ACP mode"..option('experimental-acp', ...)registration carries the description "Starts the agent in ACP mode (deprecated, use --acp instead)", which is the basis for the deprecation note.docs/cli/acp-mode.mdline 1 confirms the expansion "ACP (Agent Client Protocol)" and line 8 documentsgemini --acp../acp-mode.mdresolves fromdocs/cli/cli-reference.md(both live indocs/cli/).I also diffed every flag in the reference table against the options registered in
config.tsto make sure I wasn't missing another stale row;--experimental-zed-integrationwas the only documented flag with no implementation.Pre-Merge Checklist
Platform matrix left unchecked on purpose rather than ticked without being exercised — this is a single
.mdtable with no code path.npm run preflightnot run for the same reason; happy to run it if you want it recorded.