@office-ai/aioncli-core 0.26.0 → 0.30.1

package/dist/docs/cli/creating-skills.md

@@ -0,0 +1,80 @@
+# Creating Agent Skills
+
+This guide provides an overview of how to create your own Agent Skills to extend
+the capabilities of Gemini CLI.
+
+## Getting started: The `skill-creator` skill
+
+The recommended way to create a new skill is to use the built-in `skill-creator`
+skill. To use it, ask Gemini CLI to create a new skill for you.
+
+**Example prompt:**
+
+> "create a new skill called 'code-reviewer'"
+
+Gemini CLI will then use the `skill-creator` to generate the skill:
+
+1.  Generate a new directory for your skill (e.g., `my-new-skill/`).
+2.  Create a `SKILL.md` file with the necessary YAML frontmatter (`name` and
+    `description`).
+3.  Create the standard resource directories: `scripts/`, `references/`, and
+    `assets/`.
+
+## Manual skill creation
+
+If you prefer to create skills manually:
+
+1.  **Create a directory** for your skill (e.g., `my-new-skill/`).
+2.  **Create a `SKILL.md` file** inside the new directory.
+
+To add additional resources that support the skill, refer to the skill
+structure.
+
+## Skill structure
+
+A skill is a directory containing a `SKILL.md` file at its root.
+
+### Folder structure
+
+While a `SKILL.md` file is the only required component, we recommend the
+following structure for organizing your skill's resources:
+
+```text
+my-skill/
+├── SKILL.md       (Required) Instructions and metadata
+├── scripts/       (Optional) Executable scripts
+├── references/    (Optional) Static documentation
+└── assets/        (Optional) Templates and other resources
+```
+
+### `SKILL.md` file
+
+The `SKILL.md` file is the core of your skill. This file uses YAML frontmatter
+for metadata and Markdown for instructions. For example:
+
+```markdown
+---
+name: code-reviewer
+description:
+  Use this skill to review code. It supports both local changes and remote Pull
+  Requests.
+---
+
+# Code Reviewer
+
+This skill guides the agent in conducting thorough code reviews.
+
+## Workflow
+
+### 1. Determine Review Target
+
+- **Remote PR**: If the user gives a PR number or URL, target that remote PR.
+- **Local Changes**: If changes are local... ...
+```
+
+- **`name`**: A unique identifier for the skill. This should match the directory
+  name.
+- **`description`**: A description of what the skill does and when Gemini should
+  use it.
+- **Body**: The Markdown body of the file contains the instructions that guide
+  the agent's behavior when the skill is active.

package/dist/docs/cli/custom-commands.md

@@ -30,6 +30,9 @@ separator (`/` or `\`) being converted to a colon (`:`).
 - A file at `<project>/.gemini/commands/git/commit.toml` becomes the namespaced
   command `/git:commit`.
 
+> [!TIP] After creating or modifying `.toml` command files, run
+> `/commands reload` to pick up your changes without restarting the CLI.
+
 ## TOML file format (v1)
 
 Your command definition files must be written in the TOML format and use the
@@ -50,7 +53,7 @@ Your command definition files must be written in the TOML format and use the
 ## Handling arguments
 
 Custom commands support two powerful methods for handling arguments. The CLI
-automatically chooses the correct method based on the content of your command\'s
+automatically chooses the correct method based on the content of your command's
 `prompt`.
 
 ### 1. Context-aware injection with `{{args}}`
@@ -96,13 +99,13 @@ Search Results:
 """
 ```
 
-When you run `/grep-code It\'s complicated`:
+When you run `/grep-code It's complicated`:
 
 1. The CLI sees `{{args}}` used both outside and inside `!{...}`.
-2. Outside: The first `{{args}}` is replaced raw with `It\'s complicated`.
+2. Outside: The first `{{args}}` is replaced raw with `It's complicated`.
 3. Inside: The second `{{args}}` is replaced with the escaped version (e.g., on
    Linux: `"It\'s complicated"`).
-4. The command executed is `grep -r "It\'s complicated" .`.
+4. The command executed is `grep -r "It's complicated" .`.
 5. The CLI prompts you to confirm this exact, secure command before execution.
 6. The final prompt is sent.
 
@@ -129,13 +132,13 @@ format and behavior.
 # In: <project>/.gemini/commands/changelog.toml
 # Invoked via: /changelog 1.2.0 added "Support for default argument parsing."
 
-description = "Adds a new entry to the project\'s CHANGELOG.md file."
+description = "Adds a new entry to the project's CHANGELOG.md file."
 prompt = """
 # Task: Update Changelog
 
 You are an expert maintainer of this software project. A user has invoked a command to add a new entry to the changelog.
 
-**The user\'s raw command is appended below your instructions.**
+**The user's raw command is appended below your instructions.**
 
 Your task is to parse the `<version>`, `<change_type>`, and `<message>` from their input and use the `write_file` tool to correctly update the `CHANGELOG.md` file.
 
@@ -147,7 +150,7 @@ The command follows this format: `/changelog <version> <type> <message>`
 1. Read the `CHANGELOG.md` file.
 2. Find the section for the specified `<version>`.
 3. Add the `<message>` under the correct `<type>` heading.
-4. If the version or type section doesn\'t exist, create it.
+4. If the version or type section doesn't exist, create it.
 5. Adhere strictly to the "Keep a Changelog" format.
 """
 ```
@@ -241,7 +244,7 @@ operate on specific files.
 **Example (`review.toml`):**
 
 This command injects the content of a _fixed_ best practices file
-(`docs/best-practices.md`) and uses the user\'s arguments to provide context for
+(`docs/best-practices.md`) and uses the user's arguments to provide context for
 the review.
 
 ```toml
@@ -293,7 +296,7 @@ practice.
 description = "Asks the model to refactor the current context into a pure function."
 
 prompt = """
-Please analyze the code I\'ve provided in the current context.
+Please analyze the code I've provided in the current context.
 Refactor it into a pure function.
 
 Your response should include:

package/dist/docs/cli/enterprise.md

@@ -203,12 +203,29 @@ with the actual Gemini CLI process, which inherits the environment variable.
 This makes it significantly more difficult for a user to bypass the enforced
 settings.
 
+## User isolation in shared environments
+
+In shared compute environments (like ML experiment runners or shared build
+servers), you can isolate Gemini CLI state by overriding the user's home
+directory.
+
+By default, Gemini CLI stores configuration and history in `~/.gemini`. You can
+use the `GEMINI_CLI_HOME` environment variable to point to a unique directory
+for a specific user or job. The CLI will create a `.gemini` folder inside the
+specified path.
+
+```bash
+# Isolate state for a specific job
+export GEMINI_CLI_HOME="/tmp/gemini-job-123"
+gemini
+```
+
 ## Restricting tool access
 
 You can significantly enhance security by controlling which tools the Gemini
-model can use. This is achieved through the `tools.core` and `tools.exclude`
-settings. For a list of available tools, see the
-[Tools documentation](../tools/index.md).
+model can use. This is achieved through the `tools.core` setting and the
+[Policy Engine](../core/policy-engine.md). For a list of available tools, see
+the [Tools documentation](../tools/index.md).
 
 ### Allowlisting with `coreTools`
 
@@ -226,7 +243,10 @@ on the approved list.
 }
 ```
 
-### Blocklisting with `excludeTools`
+### Blocklisting with `excludeTools` (Deprecated)
+
+> **Deprecated:** Use the [Policy Engine](../core/policy-engine.md) for more
+> robust control.
 
 Alternatively, you can add specific tools that are considered dangerous in your
 environment to a blocklist.
@@ -463,7 +483,7 @@ avoid collecting potentially sensitive information from user prompts.
 You can enforce a specific authentication method for all users by setting the
 `enforcedAuthType` in the system-level `settings.json` file. This prevents users
 from choosing a different authentication method. See the
-[Authentication docs](./authentication.md) for more details.
+[Authentication docs](../get-started/authentication.md) for more details.
 
 **Example:** Enforce the use of Google login for all users.
 

package/dist/docs/cli/gemini-md.md

@@ -19,18 +19,18 @@ order:
     - **Location:** `~/.gemini/GEMINI.md` (in your user home directory).
     - **Scope:** Provides default instructions for all your projects.
 
-2.  **Project root and ancestor context files:**
-    - **Location:** The CLI searches for a `GEMINI.md` file in your current
-      working directory and then in each parent directory up to the project root
-      (identified by a `.git` folder).
-    - **Scope:** Provides context relevant to the entire project.
-
-3.  **Sub-directory context files:**
-    - **Location:** The CLI also scans for `GEMINI.md` files in subdirectories
-      below your current working directory. It respects rules in `.gitignore`
-      and `.geminiignore`.
-    - **Scope:** Lets you write highly specific instructions for a particular
-      component or module.
+2.  **Environment and workspace context files:**
+    - **Location:** The CLI searches for `GEMINI.md` files in your configured
+      workspace directories and their parent directories.
+    - **Scope:** Provides context relevant to the projects you are currently
+      working on.
+
+3.  **Just-in-time (JIT) context files:**
+    - **Location:** When a tool accesses a file or directory, the CLI
+      automatically scans for `GEMINI.md` files in that directory and its
+      ancestors up to a trusted root.
+    - **Scope:** Lets the model discover highly specific instructions for
+      particular components only when they are needed.
 
 The CLI footer displays the number of loaded context files, which gives you a
 quick visual cue of the active instructional context.
@@ -106,3 +106,11 @@ While `GEMINI.md` is the default filename, you can configure this in your
   }
 }
 ```
+
+## Next steps
+
+- Learn about [Ignoring files](./gemini-ignore.md) to exclude content from the
+  context system.
+- Explore the [Memory tool](../tools/memory.md) to save persistent memories.
+- See how to use [Custom commands](./custom-commands.md) to automate common
+  prompts.

package/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.