[docs] Update runtime-compatibility docs for Gemini CLI (#917)#945
Conversation
Document apm runtime setup gemini and the Gemini CLI runtime introduced in #917. Updates: - Overview table: three -> four runtimes, add Gemini CLI row - Quick Setup: add gemini to runtime management examples - New 'Google Gemini CLI Runtime' section with setup, authentication options, usage examples, and MCP integration note - Troubleshooting: add gemini to runtime-not-found list and add 'Command not found: gemini' entry Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the runtime compatibility documentation to include the newly supported Google Gemini CLI runtime (apm runtime setup gemini) and its setup/usage/troubleshooting guidance.
Changes:
- Expand the overview/support table from three to four runtimes by adding Google Gemini CLI.
- Add Gemini CLI quick setup and a new section documenting installation, authentication, usage, and MCP integration behavior.
- Extend troubleshooting guidance to include Gemini runtime installation and a dedicated "Command not found: gemini" entry.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/integrations/runtime-compatibility.md | Documents Gemini CLI runtime support, including setup/auth/usage/MCP integration and troubleshooting updates. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 2
| |---------|-------------|----------|---------------| | ||
| | [**GitHub Copilot CLI**](https://github.com/github/copilot-cli) | GitHub's Copilot CLI (Recommended) | Advanced AI coding, native MCP support | Auto-configured, no auth needed | | ||
| | [**OpenAI Codex**](https://github.com/openai/codex) | OpenAI's Codex CLI | Code tasks, GitHub Models API | Auto-configured with GitHub Models | | ||
| | [**Google Gemini CLI**](https://github.com/google-gemini/gemini-cli) | Google's Gemini CLI | Gemini models, sandboxed agentic tasks | Browser login or API key | |
There was a problem hiding this comment.
The Gemini row in the overview table says "Browser login or API key", but the Gemini section below documents three auth modes (browser login, GOOGLE_API_KEY, and Vertex AI). Consider updating the table cell to include Vertex AI as well to keep the page consistent.
| | [**Google Gemini CLI**](https://github.com/google-gemini/gemini-cli) | Google's Gemini CLI | Gemini models, sandboxed agentic tasks | Browser login or API key | | |
| | [**Google Gemini CLI**](https://github.com/google-gemini/gemini-cli) | Google's Gemini CLI | Gemini models, sandboxed agentic tasks | Browser login, API key, or Vertex AI | |
| gemini -s | ||
|
|
||
| # Specify model | ||
| gemini -m gemini-2.5-pro-preview |
There was a problem hiding this comment.
The example model name here (gemini-2.5-pro-preview) is inconsistent with the model example printed by the runtime setup script (setup-gemini.sh shows gemini-3.1-pro-preview). To avoid confusion and doc drift, align this example with the setup output or make it a generic placeholder (e.g., "gemini -m ").
| gemini -m gemini-2.5-pro-preview | |
| gemini -m <model> |
APM Review Panel VerdictDisposition: APPROVE (one minor optional cleanup noted below) Per-persona findingsPython Architect: Documentation-only PR -- no Python code changes. The diff documents the Gemini CLI runtime that shipped in #917 and is fully implemented. Technical accuracy was verified against the live implementation. OO / class diagram -- Gemini runtime problem space: classDiagram
direction LR
class RuntimeManager {
<<Service>>
+supported_runtimes dict
+setup_runtime(name) bool
+remove_runtime(name) bool
}
class GeminiClientAdapter {
<<Adapter>>
+supports_user_scope bool
+get_config_path() str
+update_config(updates) void
+get_current_config() dict
+_format_server_config(info) dict
}
class CopilotClientAdapter {
<<Adapter>>
+_select_package(info) str
+_resolve_env_vars(info) dict
}
class TargetProfile {
<<ValueObject>>
+name str
+root_dir str
+primitives dict
+auto_create bool
+detect_by_dir bool
}
RuntimeManager ..> GeminiClientAdapter : uses for MCP config
GeminiClientAdapter --|> CopilotClientAdapter : extends
TargetProfile ..> GeminiClientAdapter : configured by
Execution-flow diagram -- documented flows: flowchart TD
A[apm runtime setup gemini] --> B[RuntimeManager.setup_runtime]
B --> C[setup-gemini.sh]
C --> D[npm install -g `@google/gemini-cli`]
C --> E[Create ~/.gemini/settings.json with empty mcpServers]
F[apm install] --> G{.gemini/ dir exists?}
G -- Yes --> H[GeminiClientAdapter.update_config]
H --> I[.gemini/settings.json updated with mcpServers]
G -- No --> J[Skip silently -- opt-in behavior]
Design patterns: Adapter pattern ( Accuracy findings:
CLI Logging Expert: Documentation-only PR. No DevX UX Expert: Documentation is well-structured and consistent with the Copilot CLI and Codex sections. Command surface ( Supply Chain Security Expert: Documentation-only PR. No changes to dependency resolution, lockfile integrity, package downloads, or authentication code. The doc accurately states that Auth Expert: Not activated -- PR touches only OSS Growth Hacker: Positive growth signal. Gemini CLI is Google's fast-growing entry into agentic coding; first-class docs for it reinforce APM's "universal AI tool manager" positioning. Updating the overview table to "four runtimes" is a concrete, quotable capability claim. The MCP integration note and the cross-link to the IDE integration guide create a clear adoption path for Gemini CLI users discovering APM. Side-channel to CEO: The four-runtime milestone (Copilot, Codex, Gemini, LLM) is worth a brief release-note callout and a CEO arbitrationAll specialists agreed: this is a clean, accurate, well-structured documentation follow-up to the Gemini CLI feature shipped in #917. There are no disagreements to resolve. The single minor inconsistency (model name in docs vs. setup script) is cosmetic and does not block merge. Strategically, shipping this doc promptly after the feature lands is the right call -- docs lag is a silent conversion killer. The four-runtime positioning is a useful growth asset worth amplifying in the next release note. Disposition ratified: APPROVE. Required actions before mergeNone. Optional follow-ups
|
Documentation Updates - 2026-04-26
This PR updates
runtime-compatibility.mdto document the Gemini CLI runtime added in #917.Features Documented
apm runtime setup gemini) — from feat(gemini): add Gemini CLI as supported target with integration tests #917Changes Made
docs/src/content/docs/integrations/runtime-compatibility.md:apm runtime setup geminito the runtime management example blockapm runtime setup gemini)GOOGLE_API_KEY/ Vertex AI)apm.ymlscript configuration.gemini/settings.json)geminito the "Runtime not found" install list; added "Command not found: gemini" entryMerged PRs Referenced
feat(gemini): add Gemini CLI as supported target with integration testsNotes
The other documentation files updated as part of #917 (
ide-tool-integration.md,compilation.md,quick-start.md,how-it-works.md,cli-commands.md, CHANGELOG) already included Gemini. This PR closes the remaining gap inruntime-compatibility.md.