@office-ai/aioncli-core 0.26.0 → 0.30.0

package/dist/docs/index.md

@@ -1,147 +1,146 @@
-# Welcome to Gemini CLI documentation
-
-This documentation provides a comprehensive guide to installing, using, and
-developing Gemini CLI, a tool that lets you interact with Gemini models through
-a command-line interface.
-
-## Gemini CLI overview
-
-Gemini CLI brings the capabilities of Gemini models to your terminal in an
-interactive Read-Eval-Print Loop (REPL) environment. Gemini CLI consists of a
-client-side application (`packages/cli`) that communicates with a local server
-(`packages/core`), which in turn manages requests to the Gemini API and its AI
-models. Gemini CLI also contains a variety of tools for tasks such as performing
-file system operations, running shells, and web fetching, which are managed by
-`packages/core`.
-
-## Navigating the documentation
-
-This documentation is organized into the following sections:
-
-### Overview
-
-- **[Architecture overview](./architecture.md):** Understand the high-level
-  design of Gemini CLI, including its components and how they interact.
-- **[Contribution guide](../CONTRIBUTING.md):** Information for contributors and
-  developers, including setup, building, testing, and coding conventions.
-
-### Get started
-
-- **[Gemini CLI quickstart](./get-started/index.md):** Let's get started with
-  Gemini CLI.
-- **[Gemini 3 Pro on Gemini CLI](./get-started/gemini-3.md):** Learn how to
-  enable and use Gemini 3.
-- **[Authentication](./get-started/authentication.md):** Authenticate to Gemini
-  CLI.
-- **[Configuration](./get-started/configuration.md):** Learn how to configure
-  the CLI.
-- **[Installation](./get-started/installation.md):** Install and run Gemini CLI.
-- **[Examples](./get-started/examples.md):** Example usage of Gemini CLI.
-
-### CLI
-
-- **[Introduction: Gemini CLI](./cli/index.md):** Overview of the command-line
-  interface.
-- **[Commands](./cli/commands.md):** Description of available CLI commands.
-- **[Checkpointing](./cli/checkpointing.md):** Documentation for the
-  checkpointing feature.
-- **[Custom commands](./cli/custom-commands.md):** Create your own commands and
-  shortcuts for frequently used prompts.
-- **[Enterprise](./cli/enterprise.md):** Gemini CLI for enterprise.
-- **[Headless mode](./cli/headless.md):** Use Gemini CLI programmatically for
-  scripting and automation.
-- **[Keyboard shortcuts](./cli/keyboard-shortcuts.md):** A reference for all
-  keyboard shortcuts to improve your workflow.
-- **[Model selection](./cli/model.md):** Select the model used to process your
-  commands with `/model`.
-- **[Sandbox](./cli/sandbox.md):** Isolate tool execution in a secure,
-  containerized environment.
-- **[Settings](./cli/settings.md):** Configure various aspects of the CLI's
-  behavior and appearance with `/settings`.
-- **[Telemetry](./cli/telemetry.md):** Overview of telemetry in the CLI.
-- **[Themes](./cli/themes.md):** Themes for Gemini CLI.
-- **[Token caching](./cli/token-caching.md):** Token caching and optimization.
-- **[Trusted Folders](./cli/trusted-folders.md):** An overview of the Trusted
-  Folders security feature.
-- **[Tutorials](./cli/tutorials.md):** Tutorials for Gemini CLI.
-- **[Uninstall](./cli/uninstall.md):** Methods for uninstalling the Gemini CLI.
-
-### Core
-
-- **[Introduction: Gemini CLI core](./core/index.md):** Information about Gemini
-  CLI core.
-- **[Memport](./core/memport.md):** Using the Memory Import Processor.
-- **[Tools API](./core/tools-api.md):** Information on how the core manages and
-  exposes tools.
-- **[System Prompt Override](./cli/system-prompt.md):** Replace built-in system
-  instructions using `GEMINI_SYSTEM_MD`.
-
-- **[Policy Engine](./core/policy-engine.md):** Use the Policy Engine for
-  fine-grained control over tool execution.
-
-### Tools
-
-- **[Introduction: Gemini CLI tools](./tools/index.md):** Information about
-  Gemini CLI's tools.
-- **[File system tools](./tools/file-system.md):** Documentation for the
-  `read_file` and `write_file` tools.
-- **[Shell tool](./tools/shell.md):** Documentation for the `run_shell_command`
-  tool.
-- **[Web fetch tool](./tools/web-fetch.md):** Documentation for the `web_fetch`
-  tool.
-- **[Web search tool](./tools/web-search.md):** Documentation for the
-  `google_web_search` tool.
-- **[Memory tool](./tools/memory.md):** Documentation for the `save_memory`
-  tool.
-- **[Todo tool](./tools/todos.md):** Documentation for the `write_todos` tool.
-- **[MCP servers](./tools/mcp-server.md):** Using MCP servers with Gemini CLI.
-
-### Extensions
-
-- **[Introduction: Extensions](./extensions/index.md):** How to extend the CLI
-  with new functionality.
-- **[Get Started with extensions](./extensions/getting-started-extensions.md):**
-  Learn how to build your own extension.
-- **[Extension releasing](./extensions/extension-releasing.md):** How to release
-  Gemini CLI extensions.
-
-### Hooks
-
-- **[Hooks](./hooks/index.md):** Intercept and customize Gemini CLI behavior at
-  key lifecycle points.
-- **[Writing Hooks](./hooks/writing-hooks.md):** Learn how to create your first
-  hook with a comprehensive example.
-- **[Best Practices](./hooks/best-practices.md):** Security, performance, and
-  debugging guidelines for hooks.
-
-### IDE integration
-
-- **[Introduction to IDE integration](./ide-integration/index.md):** Connect the
-  CLI to your editor.
-- **[IDE companion extension spec](./ide-integration/ide-companion-spec.md):**
-  Spec for building IDE companion extensions.
-
-### Development
-
-- **[NPM](./npm.md):** Details on how the project's packages are structured.
-- **[Releases](./releases.md):** Information on the project's releases and
-  deployment cadence.
-- **[Changelog](./changelogs/index.md):** Highlights and notable changes to
-  Gemini CLI.
-- **[Integration tests](./integration-tests.md):** Information about the
-  integration testing framework used in this project.
-- **[Issue and PR automation](./issue-and-pr-automation.md):** A detailed
-  overview of the automated processes we use to manage and triage issues and
-  pull requests.
-
-### Support
-
-- **[FAQ](./faq.md):** Frequently asked questions.
-- **[Troubleshooting guide](./troubleshooting.md):** Find solutions to common
-  problems.
-- **[Quota and pricing](./quota-and-pricing.md):** Learn about the free tier and
-  paid options.
-- **[Terms of service and privacy notice](./tos-privacy.md):** Information on
-  the terms of service and privacy notices applicable to your use of Gemini CLI.
-
-We hope this documentation helps you make the most of Gemini CLI!
+# Gemini CLI documentation
+
+Gemini CLI brings the power of Gemini models directly into your terminal. Use it
+to understand code, automate tasks, and build workflows with your local project
+context.
+
+## Install
+
+```bash
+npm install -g @google/gemini-cli
+```
+
+## Get started
+
+Jump in to Gemini CLI.
+
+- **[Quickstart](./get-started/index.md):** Your first session with Gemini CLI.
+- **[Installation](./get-started/installation.md):** How to install Gemini CLI
+  on your system.
+- **[Authentication](./get-started/authentication.md):** Setup instructions for
+  personal and enterprise accounts.
+- **[Examples](./get-started/examples.md):** Practical examples of Gemini CLI in
+  action.
+- **[Cheatsheet](./cli/cli-reference.md):** A quick reference for common
+  commands and options.
+
+## Use Gemini CLI
+
+User-focused guides and tutorials for daily development workflows.
+
+- **[File management](./cli/tutorials/file-management.md):** How to work with
+  local files and directories.
+- **[Manage context and memory](./cli/tutorials/memory-management.md):**
+  Managing persistent instructions and facts.
+- **[Execute shell commands](./cli/tutorials/shell-commands.md):** Executing
+  system commands safely.
+- **[Manage sessions and history](./cli/tutorials/session-management.md):**
+  Resuming, managing, and rewinding conversations.
+- **[Plan tasks with todos](./cli/tutorials/task-planning.md):** Using todos for
+  complex workflows.
+- **[Web search and fetch](./cli/tutorials/web-tools.md):** Searching and
+  fetching content from the web.
+- **[Get started with skills](./cli/tutorials/skills-getting-started.md):**
+  Getting started with specialized expertise.
+
+## Features
+
+Technical reference documentation for each capability of Gemini CLI.
+
+- **[/about](./cli/commands.md#about):** About Gemini CLI.
+- **[/auth](./get-started/authentication.md):** Authentication.
+- **[/bug](./cli/commands.md#bug):** Report a bug.
+- **[/chat](./cli/commands.md#chat):** Chat history.
+- **[/clear](./cli/commands.md#clear):** Clear screen.
+- **[/compress](./cli/commands.md#compress):** Compress context.
+- **[/copy](./cli/commands.md#copy):** Copy output.
+- **[/directory](./cli/commands.md#directory-or-dir):** Manage workspace.
+- **[/docs](./cli/commands.md#docs):** Open documentation.
+- **[/editor](./cli/commands.md#editor):** Select editor.
+- **[/extensions](./extensions/index.md):** Manage extensions.
+- **[/help](./cli/commands.md#help-or):** Show help.
+- **[/hooks](./hooks/index.md):** Hooks.
+- **[/ide](./ide-integration/index.md):** IDE integration.
+- **[/init](./cli/commands.md#init):** Initialize context.
+- **[/mcp](./tools/mcp-server.md):** MCP servers.
+- **[/memory](./cli/commands.md#memory):** Manage memory.
+- **[/model](./cli/model.md):** Model selection.
+- **[/policies](./cli/commands.md#policies):** Manage policies.
+- **[/privacy](./cli/commands.md#privacy):** Privacy notice.
+- **[/quit](./cli/commands.md#quit-or-exit):** Exit CLI.
+- **[/restore](./cli/checkpointing.md):** Restore files.
+- **[/resume](./cli/commands.md#resume):** Resume session.
+- **[/rewind](./cli/rewind.md):** Rewind.
+- **[/settings](./cli/settings.md):** Settings.
+- **[/setup-github](./cli/commands.md#setup-github):** GitHub setup.
+- **[/shells](./cli/commands.md#shells-or-bashes):** Manage processes.
+- **[/skills](./cli/skills.md):** Agent skills.
+- **[/stats](./cli/commands.md#stats):** Session statistics.
+- **[/terminal-setup](./cli/commands.md#terminal-setup):** Terminal keybindings.
+- **[/theme](./cli/themes.md):** Themes.
+- **[/tools](./cli/commands.md#tools):** List tools.
+- **[/vim](./cli/commands.md#vim):** Vim mode.
+- **[Activate skill (tool)](./tools/activate-skill.md):** Internal mechanism for
+  loading expert procedures.
+- **[Ask user (tool)](./tools/ask-user.md):** Internal dialog system for
+  clarification.
+- **[Checkpointing](./cli/checkpointing.md):** Automatic session snapshots.
+- **[File system (tool)](./tools/file-system.md):** Technical details for local
+  file operations.
+- **[Headless mode](./cli/headless.md):** Programmatic and scripting interface.
+- **[Internal documentation (tool)](./tools/internal-docs.md):** Technical
+  lookup for CLI features.
+- **[Memory (tool)](./tools/memory.md):** Storage details for persistent facts.
+- **[Model routing](./cli/model-routing.md):** Automatic fallback resilience.
+- **[Plan mode (experimental)](./cli/plan-mode.md):** Use a safe, read-only mode
+  for planning complex changes.
+- **[Sandboxing](./cli/sandbox.md):** Isolate tool execution.
+- **[Shell (tool)](./tools/shell.md):** Detailed system execution parameters.
+- **[Telemetry](./cli/telemetry.md):** Usage and performance metric details.
+- **[Todo (tool)](./tools/todos.md):** Progress tracking specification.
+- **[Token caching](./cli/token-caching.md):** Performance optimization.
+- **[Web fetch (tool)](./tools/web-fetch.md):** URL retrieval and extraction
+  details.
+- **[Web search (tool)](./tools/web-search.md):** Google Search integration
+  technicals.
+
+## Configuration
+
+Settings and customization options for Gemini CLI.
+
+- **[Custom commands](./cli/custom-commands.md):** Personalized shortcuts.
+- **[Enterprise configuration](./cli/enterprise.md):** Professional environment
+  controls.
+- **[Ignore files (.geminiignore)](./cli/gemini-ignore.md):** Exclusion pattern
+  reference.
+- **[Model configuration](./cli/generation-settings.md):** Fine-tune generation
+  parameters like temperature and thinking budget.
+- **[Project context (GEMINI.md)](./cli/gemini-md.md):** Technical hierarchy of
+  context files.
+- **[Settings](./cli/settings.md):** Full configuration reference.
+- **[System prompt override](./cli/system-prompt.md):** Instruction replacement
+  logic.
+- **[Themes](./cli/themes.md):** UI personalization technical guide.
+- **[Trusted folders](./cli/trusted-folders.md):** Security permission logic.
+
+## Reference
+
+Deep technical documentation and API specifications.
+
+- **[Architecture overview](./architecture.md):** System design and components.
+- **[Command reference](./cli/commands.md):** Detailed slash command guide.
+- **[Configuration reference](./get-started/configuration.md):** Settings and
+  environment variables.
+- **[Core concepts](./core/concepts.md):** Fundamental terminology and
+  definitions.
+- **[Keyboard shortcuts](./cli/keyboard-shortcuts.md):** Productivity tips.
+- **[Policy engine](./core/policy-engine.md):** Fine-grained execution control.
+
+## Resources
+
+Support, release history, and legal information.
+
+- **[FAQ](./faq.md):** Answers to frequently asked questions.
+- **[Changelogs](./changelogs/index.md):** Highlights and notable changes.
+- **[Quota and pricing](./quota-and-pricing.md):** Limits and billing details.
+- **[Terms and privacy](./tos-privacy.md):** Official notices and terms.

package/dist/docs/local-development.md

@@ -10,7 +10,7 @@ debug your code by instrumenting interesting events like model calls, tool
 scheduler, tool calls, etc.
 
 Dev traces are verbose and are specifically meant for understanding agent
-behaviour and debugging issues. They are disabled by default.
+behavior and debugging issues. They are disabled by default.
 
 To enable dev traces, set the `GEMINI_DEV_TRACING=true` environment variable
 when running Gemini CLI.

package/dist/docs/releases.md

@@ -12,7 +12,7 @@ Dressing Room, which is Google's system for managing NPM packages in the
 `@google/**` namespace. The packages are all named `@google/**`.
 
 More information can be found about these systems in the
-[maintainer repo guide](https://github.com/google-gemini/maintainers-gemini-cli/blob/main/npm.md)
+[NPM Package Overview](npm.md)
 
 ### Package scopes
 
@@ -29,7 +29,7 @@ or if we have to deviate from it. Our weekly releases will be minor version
 increments and any bug or hotfixes between releases will go out as patch
 versions on the most recent release.
 
-Each Tuesday ~2000 UTC new Stable and Preview releases will be cut. The
+Each Tuesday ~20:00 UTC new Stable and Preview releases will be cut. The
 promotion flow is:
 
 - Code is committed to main and pushed each night to nightly
@@ -58,7 +58,7 @@ npm install -g @google/gemini-cli@latest
 
 ### Nightly
 
-- New releases will be published each day at UTC 0000. This will be all changes
+- New releases will be published each day at UTC 00:00. This will be all changes
   from the main branch as represented at time of release. It should be assumed
   there are pending validations and issues. Use `nightly` tag.