@mmmbuto/gemini-cli-termux 0.30.3-termux → 0.30.5-termux

package/packages/core/dist/docs/cli/headless.md

@@ -1,388 +1,50 @@
-# Headless mode
+# Headless mode reference
 
-Headless mode allows you to run Gemini CLI programmatically from command line
-scripts and automation tools without any interactive UI. This is ideal for
-scripting, automation, CI/CD pipelines, and building AI-powered tools.
+Headless mode provides a programmatic interface to Gemini CLI, returning
+structured text or JSON output without an interactive terminal UI.
 
-- [Headless Mode](#headless-mode)
-  - [Overview](#overview)
-  - [Basic Usage](#basic-usage)
-    - [Direct Prompts](#direct-prompts)
-    - [Stdin Input](#stdin-input)
-    - [Combining with File Input](#combining-with-file-input)
-  - [Output Formats](#output-formats)
-    - [Text Output (Default)](#text-output-default)
-    - [JSON Output](#json-output)
-      - [Response Schema](#response-schema)
-      - [Example Usage](#example-usage)
-    - [Streaming JSON Output](#streaming-json-output)
-      - [When to Use Streaming JSON](#when-to-use-streaming-json)
-      - [Event Types](#event-types)
-      - [Basic Usage](#basic-usage)
-      - [Example Output](#example-output)
-      - [Processing Stream Events](#processing-stream-events)
-      - [Real-World Examples](#real-world-examples)
-    - [File Redirection](#file-redirection)
-  - [Configuration Options](#configuration-options)
-  - [Examples](#examples)
-    - [Code review](#code-review)
-    - [Generate commit messages](#generate-commit-messages)
-    - [API documentation](#api-documentation)
-    - [Batch code analysis](#batch-code-analysis)
-    - [Code review](#code-review-1)
-    - [Log analysis](#log-analysis)
-    - [Release notes generation](#release-notes-generation)
-    - [Model and tool usage tracking](#model-and-tool-usage-tracking)
-  - [Resources](#resources)
+## Technical reference
 
-## Overview
+Headless mode is triggered when the CLI is run in a non-TTY environment or when
+providing a query as a positional argument without the interactive flag.
 
-The headless mode provides a headless interface to Gemini CLI that:
+### Output formats
 
-- Accepts prompts via command line arguments or stdin
-- Returns structured output (text or JSON)
-- Supports file redirection and piping
-- Enables automation and scripting workflows
-- Provides consistent exit codes for error handling
+You can specify the output format using the `--output-format` flag.
 
-## Basic usage
+#### JSON output
 
-### Direct prompts
+Returns a single JSON object containing the response and usage statistics.
 
-Use the `--prompt` (or `-p`) flag to run in headless mode:
+- **Schema:**
+  - `response`: (string) The model's final answer.
+  - `stats`: (object) Token usage and API latency metrics.
+  - `error`: (object, optional) Error details if the request failed.
 
-```bash
-gemini --prompt "What is machine learning?"
-```
+#### Streaming JSON output
 
-### Stdin input
+Returns a stream of newline-delimited JSON (JSONL) events.
 
-Pipe input to Gemini CLI from your terminal:
+- **Event types:**
+  - `init`: Session metadata (session ID, model).
+  - `message`: User and assistant message chunks.
+  - `tool_use`: Tool call requests with arguments.
+  - `tool_result`: Output from executed tools.
+  - `error`: Non-fatal warnings and system errors.
+  - `result`: Final outcome with aggregated statistics.
 
-```bash
-echo "Explain this code" | gemini
-```
+## Exit codes
 
-### Combining with file input
+The CLI returns standard exit codes to indicate the result of the headless
+execution:
 
-Read from files and process with Gemini:
+- `0`: Success.
+- `1`: General error or API failure.
+- `42`: Input error (invalid prompt or arguments).
+- `53`: Turn limit exceeded.
 
-```bash
-cat README.md | gemini --prompt "Summarize this documentation"
-```
+## Next steps
 
-## Output formats
-
-### Text output (default)
-
-Standard human-readable output:
-
-```bash
-gemini -p "What is the capital of France?"
-```
-
-Response format:
-
-```
-The capital of France is Paris.
-```
-
-### JSON output
-
-Returns structured data including response, statistics, and metadata. This
-format is ideal for programmatic processing and automation scripts.
-
-#### Response schema
-
-The JSON output follows this high-level structure:
-
-```json
-{
-  "response": "string", // The main AI-generated content answering your prompt
-  "stats": {
-    // Usage metrics and performance data
-    "models": {
-      // Per-model API and token usage statistics
-      "[model-name]": {
-        "api": {
-          /* request counts, errors, latency */
-        },
-        "tokens": {
-          /* prompt, response, cached, total counts */
-        }
-      }
-    },
-    "tools": {
-      // Tool execution statistics
-      "totalCalls": "number",
-      "totalSuccess": "number",
-      "totalFail": "number",
-      "totalDurationMs": "number",
-      "totalDecisions": {
-        /* accept, reject, modify, auto_accept counts */
-      },
-      "byName": {
-        /* per-tool detailed stats */
-      }
-    },
-    "files": {
-      // File modification statistics
-      "totalLinesAdded": "number",
-      "totalLinesRemoved": "number"
-    }
-  },
-  "error": {
-    // Present only when an error occurred
-    "type": "string", // Error type (e.g., "ApiError", "AuthError")
-    "message": "string", // Human-readable error description
-    "code": "number" // Optional error code
-  }
-}
-```
-
-#### Example usage
-
-```bash
-gemini -p "What is the capital of France?" --output-format json
-```
-
-Response:
-
-```json
-{
-  "response": "The capital of France is Paris.",
-  "stats": {
-    "models": {
-      "gemini-2.5-pro": {
-        "api": {
-          "totalRequests": 2,
-          "totalErrors": 0,
-          "totalLatencyMs": 5053
-        },
-        "tokens": {
-          "prompt": 24939,
-          "candidates": 20,
-          "total": 25113,
-          "cached": 21263,
-          "thoughts": 154,
-          "tool": 0
-        }
-      },
-      "gemini-2.5-flash": {
-        "api": {
-          "totalRequests": 1,
-          "totalErrors": 0,
-          "totalLatencyMs": 1879
-        },
-        "tokens": {
-          "prompt": 8965,
-          "candidates": 10,
-          "total": 9033,
-          "cached": 0,
-          "thoughts": 30,
-          "tool": 28
-        }
-      }
-    },
-    "tools": {
-      "totalCalls": 1,
-      "totalSuccess": 1,
-      "totalFail": 0,
-      "totalDurationMs": 1881,
-      "totalDecisions": {
-        "accept": 0,
-        "reject": 0,
-        "modify": 0,
-        "auto_accept": 1
-      },
-      "byName": {
-        "google_web_search": {
-          "count": 1,
-          "success": 1,
-          "fail": 0,
-          "durationMs": 1881,
-          "decisions": {
-            "accept": 0,
-            "reject": 0,
-            "modify": 0,
-            "auto_accept": 1
-          }
-        }
-      }
-    },
-    "files": {
-      "totalLinesAdded": 0,
-      "totalLinesRemoved": 0
-    }
-  }
-}
-```
-
-### Streaming JSON output
-
-Returns real-time events as newline-delimited JSON (JSONL). Each significant
-action (initialization, messages, tool calls, results) emits immediately as it
-occurs. This format is ideal for monitoring long-running operations, building
-UIs with live progress, and creating automation pipelines that react to events.
-
-#### When to use streaming JSON
-
-Use `--output-format stream-json` when you need:
-
-- **Real-time progress monitoring** - See tool calls and responses as they
-  happen
-- **Event-driven automation** - React to specific events (e.g., tool failures)
-- **Live UI updates** - Build interfaces showing AI agent activity in real-time
-- **Detailed execution logs** - Capture complete interaction history with
-  timestamps
-- **Pipeline integration** - Stream events to logging/monitoring systems
-
-#### Event types
-
-The streaming format emits 6 event types:
-
-1. **`init`** - Session starts (includes session_id, model)
-2. **`message`** - User prompts and assistant responses
-3. **`tool_use`** - Tool call requests with parameters
-4. **`tool_result`** - Tool execution results (success/error)
-5. **`error`** - Non-fatal errors and warnings
-6. **`result`** - Final session outcome with aggregated stats
-
-#### Basic usage
-
-```bash
-# Stream events to console
-gemini --output-format stream-json --prompt "What is 2+2?"
-
-# Save event stream to file
-gemini --output-format stream-json --prompt "Analyze this code" > events.jsonl
-
-# Parse with jq
-gemini --output-format stream-json --prompt "List files" | jq -r '.type'
-```
-
-#### Example output
-
-Each line is a complete JSON event:
-
-```jsonl
-{"type":"init","timestamp":"2025-10-10T12:00:00.000Z","session_id":"abc123","model":"gemini-2.0-flash-exp"}
-{"type":"message","role":"user","content":"List files in current directory","timestamp":"2025-10-10T12:00:01.000Z"}
-{"type":"tool_use","tool_name":"Bash","tool_id":"bash-123","parameters":{"command":"ls -la"},"timestamp":"2025-10-10T12:00:02.000Z"}
-{"type":"tool_result","tool_id":"bash-123","status":"success","output":"file1.txt\nfile2.txt","timestamp":"2025-10-10T12:00:03.000Z"}
-{"type":"message","role":"assistant","content":"Here are the files...","delta":true,"timestamp":"2025-10-10T12:00:04.000Z"}
-{"type":"result","status":"success","stats":{"total_tokens":250,"input_tokens":50,"output_tokens":200,"duration_ms":3000,"tool_calls":1},"timestamp":"2025-10-10T12:00:05.000Z"}
-```
-
-### File redirection
-
-Save output to files or pipe to other commands:
-
-```bash
-# Save to file
-gemini -p "Explain Docker" > docker-explanation.txt
-gemini -p "Explain Docker" --output-format json > docker-explanation.json
-
-# Append to file
-gemini -p "Add more details" >> docker-explanation.txt
-
-# Pipe to other tools
-gemini -p "What is Kubernetes?" --output-format json | jq '.response'
-gemini -p "Explain microservices" | wc -w
-gemini -p "List programming languages" | grep -i "python"
-```
-
-## Configuration options
-
-Key command-line options for headless usage:
-
-| Option                  | Description                        | Example                                            |
-| ----------------------- | ---------------------------------- | -------------------------------------------------- |
-| `--prompt`, `-p`        | Run in headless mode               | `gemini -p "query"`                                |
-| `--output-format`       | Specify output format (text, json) | `gemini -p "query" --output-format json`           |
-| `--model`, `-m`         | Specify the Gemini model           | `gemini -p "query" -m gemini-2.5-flash`            |
-| `--debug`, `-d`         | Enable debug mode                  | `gemini -p "query" --debug`                        |
-| `--include-directories` | Include additional directories     | `gemini -p "query" --include-directories src,docs` |
-| `--yolo`, `-y`          | Auto-approve all actions           | `gemini -p "query" --yolo`                         |
-| `--approval-mode`       | Set approval mode                  | `gemini -p "query" --approval-mode auto_edit`      |
-
-For complete details on all available configuration options, settings files, and
-environment variables, see the
-[Configuration Guide](../get-started/configuration.md).
-
-## Examples
-
-#### Code review
-
-```bash
-cat src/auth.py | gemini -p "Review this authentication code for security issues" > security-review.txt
-```
-
-#### Generate commit messages
-
-```bash
-result=$(git diff --cached | gemini -p "Write a concise commit message for these changes" --output-format json)
-echo "$result" | jq -r '.response'
-```
-
-#### API documentation
-
-```bash
-result=$(cat api/routes.js | gemini -p "Generate OpenAPI spec for these routes" --output-format json)
-echo "$result" | jq -r '.response' > openapi.json
-```
-
-#### Batch code analysis
-
-```bash
-for file in src/*.py; do
-    echo "Analyzing $file..."
-    result=$(cat "$file" | gemini -p "Find potential bugs and suggest improvements" --output-format json)
-    echo "$result" | jq -r '.response' > "reports/$(basename "$file").analysis"
-    echo "Completed analysis for $(basename "$file")" >> reports/progress.log
-done
-```
-
-#### Code review
-
-```bash
-result=$(git diff origin/main...HEAD | gemini -p "Review these changes for bugs, security issues, and code quality" --output-format json)
-echo "$result" | jq -r '.response' > pr-review.json
-```
-
-#### Log analysis
-
-```bash
-grep "ERROR" /var/log/app.log | tail -20 | gemini -p "Analyze these errors and suggest root cause and fixes" > error-analysis.txt
-```
-
-#### Release notes generation
-
-```bash
-result=$(git log --oneline v1.0.0..HEAD | gemini -p "Generate release notes from these commits" --output-format json)
-response=$(echo "$result" | jq -r '.response')
-echo "$response"
-echo "$response" >> CHANGELOG.md
-```
-
-#### Model and tool usage tracking
-
-```bash
-result=$(gemini -p "Explain this database schema" --include-directories db --output-format json)
-total_tokens=$(echo "$result" | jq -r '.stats.models // {} | to_entries | map(.value.tokens.total) | add // 0')
-models_used=$(echo "$result" | jq -r '.stats.models // {} | keys | join(", ") | if . == "" then "none" else . end')
-tool_calls=$(echo "$result" | jq -r '.stats.tools.totalCalls // 0')
-tools_used=$(echo "$result" | jq -r '.stats.tools.byName // {} | keys | join(", ") | if . == "" then "none" else . end')
-echo "$(date): $total_tokens tokens, $tool_calls tool calls ($tools_used) used with models: $models_used" >> usage.log
-echo "$result" | jq -r '.response' > schema-docs.md
-echo "Recent usage trends:"
-tail -5 usage.log
-```
-
-## Resources
-
-- [CLI Configuration](../get-started/configuration.md) - Complete configuration
-  guide
-- [Authentication](../get-started/authentication.md) - Setup authentication
-- [Commands](./commands.md) - Interactive commands reference
-- [Tutorials](./tutorials.md) - Step-by-step automation guides
+- Follow the [Automation tutorial](./tutorials/automation.md) for practical
+  scripting examples.
+- See the [CLI reference](./cli-reference.md) for all available flags.

package/packages/core/dist/docs/cli/model.md

@@ -39,7 +39,7 @@ To enable Gemini 3 Pro and Gemini 3 Flash (if available), enable
 
 You can also use the `--model` flag to specify a particular Gemini model on
 startup. For more details, refer to the
-[configuration documentation](../get-started/configuration.md).
+[configuration documentation](../reference/configuration.md).
 
 Changes to these settings will be applied to all subsequent interactions with
 Gemini CLI.

package/packages/core/dist/docs/cli/plan-mode.md

@@ -0,0 +1,245 @@
+# Plan Mode (experimental)
+
+Plan Mode is a read-only environment for architecting robust solutions before
+implementation. It allows you to:
+
+- **Research:** Explore the project in a read-only state to prevent accidental
+  changes.
+- **Design:** Understand problems, evaluate trade-offs, and choose a solution.
+- **Plan:** Align on an execution strategy before any code is modified.
+
+> **Note:** This is a preview feature currently under active development. Your
+> feedback is invaluable as we refine this feature. If you have ideas,
+> suggestions, or encounter issues:
+>
+> - [Open an issue](https://github.com/google-gemini/gemini-cli/issues) on
+>   GitHub.
+> - Use the **/bug** command within Gemini CLI to file an issue.
+
+- [Enabling Plan Mode](#enabling-plan-mode)
+- [How to use Plan Mode](#how-to-use-plan-mode)
+  - [Entering Plan Mode](#entering-plan-mode)
+  - [Planning Workflow](#planning-workflow)
+  - [Exiting Plan Mode](#exiting-plan-mode)
+- [Tool Restrictions](#tool-restrictions)
+  - [Customizing Planning with Skills](#customizing-planning-with-skills)
+  - [Customizing Policies](#customizing-policies)
+    - [Example: Allow git commands in Plan Mode](#example-allow-git-commands-in-plan-mode)
+    - [Example: Enable research subagents in Plan Mode](#example-enable-research-subagents-in-plan-mode)
+  - [Custom Plan Directory and Policies](#custom-plan-directory-and-policies)
+
+## Enabling Plan Mode
+
+To use Plan Mode, enable it via **/settings** (search for **Plan**) or add the
+following to your `settings.json`:
+
+```json
+{
+  "experimental": {
+    "plan": true
+  }
+}
+```
+
+## How to use Plan Mode
+
+### Entering Plan Mode
+
+You can configure Gemini CLI to start in Plan Mode by default or enter it
+manually during a session.
+
+- **Configuration:** Configure Gemini CLI to start directly in Plan Mode by
+  default:
+  1.  Type `/settings` in the CLI.
+  2.  Search for **Default Approval Mode**.
+  3.  Set the value to **Plan**.
+
+  Alternatively, use the `gemini --approval-mode=plan` CLI flag or manually
+  update:
+
+  ```json
+  {
+    "general": {
+      "defaultApprovalMode": "plan"
+    }
+  }
+  ```
+
+- **Keyboard Shortcut:** Press `Shift+Tab` to cycle through approval modes
+  (`Default` -> `Auto-Edit` -> `Plan`).
+
+  > **Note:** Plan Mode is automatically removed from the rotation when Gemini
+  > CLI is actively processing or showing confirmation dialogs.
+
+- **Command:** Type `/plan` in the input box.
+
+- **Natural Language:** Ask Gemini CLI to "start a plan for...". Gemini CLI then
+  calls the [`enter_plan_mode`] tool to switch modes.
+  > **Note:** This tool is not available when Gemini CLI is in [YOLO mode].
+
+### Planning Workflow
+
+1.  **Explore & Analyze:** Analyze requirements and use read-only tools to map
+    the codebase and validate assumptions. For complex tasks, identify at least
+    two viable implementation approaches.
+2.  **Consult:** Present a summary of the identified approaches via [`ask_user`]
+    to obtain a selection. For simple or canonical tasks, this step may be
+    skipped.
+3.  **Draft:** Once an approach is selected, write a detailed implementation
+    plan to the plans directory.
+4.  **Review & Approval:** Use the [`exit_plan_mode`] tool to present the plan
+    and formally request approval.
+    - **Approve:** Exit Plan Mode and start implementation.
+    - **Iterate:** Provide feedback to refine the plan.
+
+For more complex or specialized planning tasks, you can
+[customize the planning workflow with skills](#customizing-planning-with-skills).
+
+### Exiting Plan Mode
+
+To exit Plan Mode, you can:
+
+- **Keyboard Shortcut:** Press `Shift+Tab` to cycle to the desired mode.
+
+- **Tool:** Gemini CLI calls the [`exit_plan_mode`] tool to present the
+  finalized plan for your approval.
+
+## Tool Restrictions
+
+Plan Mode enforces strict safety policies to prevent accidental changes.
+
+These are the only allowed tools:
+
+- **FileSystem (Read):** [`read_file`], [`list_directory`], [`glob`]
+- **Search:** [`grep_search`], [`google_web_search`]
+- **Interaction:** [`ask_user`]
+- **MCP Tools (Read):** Read-only [MCP tools] (e.g., `github_read_issue`,
+  `postgres_read_schema`) are allowed.
+- **Planning (Write):** [`write_file`] and [`replace`] only allowed for `.md`
+  files in the `~/.gemini/tmp/<project>/<session-id>/plans/` directory or your
+  [custom plans directory](#custom-plan-directory-and-policies).
+- **Skills:** [`activate_skill`] (allows loading specialized instructions and
+  resources in a read-only manner)
+
+### Customizing Planning with Skills
+
+You can use [Agent Skills](./skills.md) to customize how Gemini CLI approaches
+planning for specific types of tasks. When a skill is activated during Plan
+Mode, its specialized instructions and procedural workflows will guide the
+research, design and planning phases.
+
+For example:
+
+- A **"Database Migration"** skill could ensure the plan includes data safety
+  checks and rollback strategies.
+- A **"Security Audit"** skill could prompt Gemini CLI to look for specific
+  vulnerabilities during codebase exploration.
+- A **"Frontend Design"** skill could guide Gemini CLI to use specific UI
+  components and accessibility standards in its proposal.
+
+To use a skill in Plan Mode, you can explicitly ask Gemini CLI to "use the
+`<skill-name>` skill to plan..." or Gemini CLI may autonomously activate it
+based on the task description.
+
+### Customizing Policies
+
+Plan Mode is designed to be read-only by default to ensure safety during the
+research phase. However, you may occasionally need to allow specific tools to
+assist in your planning.
+
+Because user policies (Tier 2) have a higher base priority than built-in
+policies (Tier 1), you can override Plan Mode's default restrictions by creating
+a rule in your `~/.gemini/policies/` directory.
+
+#### Example: Allow git commands in Plan Mode
+
+This rule allows you to check the repository status and see changes while in
+Plan Mode.
+
+`~/.gemini/policies/git-research.toml`
+
+```toml
+[[rule]]
+toolName = "run_shell_command"
+commandPrefix = ["git status", "git diff"]
+decision = "allow"
+priority = 100
+modes = ["plan"]
+```
+
+#### Example: Enable research subagents in Plan Mode
+
+You can enable experimental research [subagents] like `codebase_investigator` to
+help gather architecture details during the planning phase.
+
+`~/.gemini/policies/research-subagents.toml`
+
+```toml
+[[rule]]
+toolName = "codebase_investigator"
+decision = "allow"
+priority = 100
+modes = ["plan"]
+```
+
+Tell Gemini CLI it can use these tools in your prompt, for example: _"You can
+check ongoing changes in git."_
+
+For more information on how the policy engine works, see the [policy engine]
+docs.
+
+### Custom Plan Directory and Policies
+
+By default, planning artifacts are stored in a managed temporary directory
+outside your project: `~/.gemini/tmp/<project>/<session-id>/plans/`.
+
+You can configure a custom directory for plans in your `settings.json`. For
+example, to store plans in a `.gemini/plans` directory within your project:
+
+```json
+{
+  "general": {
+    "plan": {
+      "directory": ".gemini/plans"
+    }
+  }
+}
+```
+
+To maintain the safety of Plan Mode, user-configured paths for the plans
+directory are restricted to the project root. This ensures that custom planning
+locations defined within a project's workspace cannot be used to escape and
+overwrite sensitive files elsewhere. Any user-configured directory must reside
+within the project boundary.
+
+Using a custom directory requires updating your [policy engine] configurations
+to allow `write_file` and `replace` in that specific location. For example, to
+allow writing to the `.gemini/plans` directory within your project, create a
+policy file at `~/.gemini/policies/plan-custom-directory.toml`:
+
+```toml
+[[rule]]
+toolName = ["write_file", "replace"]
+decision = "allow"
+priority = 100
+modes = ["plan"]
+# Adjust the pattern to match your custom directory.
+# This example matches any .md file in a .gemini/plans directory within the project.
+argsPattern = "\"file_path\":\"[^\"]+[\\\\/]+\\.gemini[\\\\/]+plans[\\\\/]+[\\w-]+\\.md\""
+```
+
+[`list_directory`]: /docs/tools/file-system.md#1-list_directory-readfolder
+[`read_file`]: /docs/tools/file-system.md#2-read_file-readfile
+[`grep_search`]: /docs/tools/file-system.md#5-grep_search-searchtext
+[`write_file`]: /docs/tools/file-system.md#3-write_file-writefile
+[`glob`]: /docs/tools/file-system.md#4-glob-findfiles
+[`google_web_search`]: /docs/tools/web-search.md
+[`replace`]: /docs/tools/file-system.md#6-replace-edit
+[MCP tools]: /docs/tools/mcp-server.md
+[`activate_skill`]: /docs/cli/skills.md
+[subagents]: /docs/core/subagents.md
+[policy engine]: /docs/reference/policy-engine.md
+[`enter_plan_mode`]: /docs/tools/planning.md#1-enter_plan_mode-enterplanmode
+[`exit_plan_mode`]: /docs/tools/planning.md#2-exit_plan_mode-exitplanmode
+[`ask_user`]: /docs/tools/ask-user.md
+[YOLO mode]: /docs/reference/configuration.md#command-line-arguments