-
Notifications
You must be signed in to change notification settings - Fork 155
[docs] Update runtime-compatibility docs for Gemini CLI (#917) #945
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,12 +10,13 @@ APM manages LLM runtime installation and configuration automatically. This guide | |||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| APM acts as a runtime package manager, downloading and configuring LLM runtimes from their official sources. Currently supports three runtimes: | ||||||
| APM acts as a runtime package manager, downloading and configuring LLM runtimes from their official sources. Currently supports four runtimes: | ||||||
|
|
||||||
| | Runtime | Description | Best For | Configuration | | ||||||
| |---------|-------------|----------|---------------| | ||||||
| | [**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 | | ||||||
| | [**LLM Library**](https://llm.datasette.io/en/stable/index.html) | Simon Willison's `llm` CLI | General use, many providers | Manual API key setup | | ||||||
|
|
||||||
| ## Quick Setup | ||||||
|
|
@@ -35,6 +36,7 @@ apm runtime list # Show installed runtimes | |||||
| apm runtime setup llm # Install LLM library | ||||||
| apm runtime setup copilot # Install GitHub Copilot CLI (Recommended) | ||||||
| apm runtime setup codex # Install Codex CLI | ||||||
| apm runtime setup gemini # Install Google Gemini CLI | ||||||
| ``` | ||||||
|
|
||||||
| ## GitHub Copilot CLI Runtime (Recommended) | ||||||
|
|
@@ -109,6 +111,77 @@ scripts: | |||||
| debug: "RUST_LOG=debug codex analyze-logs.prompt.md" | ||||||
| ``` | ||||||
|
|
||||||
| ## Google Gemini CLI Runtime | ||||||
|
|
||||||
| APM automatically installs Google Gemini CLI from the public npm registry. Gemini CLI provides agentic AI coding with sandboxed execution and support for Gemini models including Gemini Pro and Gemini Flash. | ||||||
|
|
||||||
| ### Setup | ||||||
|
|
||||||
| #### 1. Install via APM | ||||||
| ```bash | ||||||
| apm runtime setup gemini | ||||||
| ``` | ||||||
|
|
||||||
| This automatically: | ||||||
| - Installs `@google/gemini-cli` from the public npm registry | ||||||
| - Requires Node.js v20+ and npm v10+ | ||||||
| - Creates `~/.gemini/settings.json` with an empty `mcpServers` section | ||||||
|
|
||||||
| #### 2. Authenticate | ||||||
|
|
||||||
| Gemini CLI supports three authentication methods: | ||||||
|
|
||||||
| ```bash | ||||||
| # Option A: Browser-based login (free tier, 60 req/min) | ||||||
| gemini # follow the interactive browser login flow | ||||||
|
|
||||||
| # Option B: Gemini API key | ||||||
| export GOOGLE_API_KEY=your_api_key | ||||||
|
|
||||||
| # Option C: Vertex AI (Google Cloud) | ||||||
| export GOOGLE_GENAI_USE_VERTEXAI=true | ||||||
| export GOOGLE_CLOUD_PROJECT=your_project_id | ||||||
| ``` | ||||||
|
|
||||||
| ### Usage | ||||||
|
|
||||||
| ```bash | ||||||
| # Run scripts (from apm.yml) with parameters | ||||||
| apm run start --param service_name=api-gateway | ||||||
|
|
||||||
| # Interactive mode | ||||||
| gemini | ||||||
|
|
||||||
| # Sandboxed mode (isolated execution) | ||||||
| gemini -s | ||||||
|
|
||||||
| # Specify model | ||||||
| gemini -m gemini-2.5-pro-preview | ||||||
|
||||||
| gemini -m gemini-2.5-pro-preview | |
| gemini -m <model> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.