@didim365/agent-cli-core 0.1.1 → 0.1.3

package/dist/docs/ide-integration/index.md

@@ -1,202 +0,0 @@
-# IDE integration
-
-Gemini CLI can integrate with your IDE to provide a more seamless and
-context-aware experience. This integration allows the CLI to understand your
-workspace better and enables powerful features like native in-editor diffing.
-
-Currently, the supported IDEs are [Antigravity](https://antigravity.google),
-[Visual Studio Code](https://code.visualstudio.com/), and other editors that
-support VS Code extensions. To build support for other editors, see the
-[IDE Companion Extension Spec](./ide-companion-spec.md).
-
-## Features
-
-- **Workspace context:** The CLI automatically gains awareness of your workspace
-  to provide more relevant and accurate responses. This context includes:
-  - The **10 most recently accessed files** in your workspace.
-  - Your active cursor position.
-  - Any text you have selected (up to a 16KB limit; longer selections will be
-    truncated).
-
-- **Native diffing:** When Gemini suggests code modifications, you can view the
-  changes directly within your IDE's native diff viewer. This allows you to
-  review, edit, and accept or reject the suggested changes seamlessly.
-
-- **VS Code commands:** You can access Gemini CLI features directly from the VS
-  Code Command Palette (`Cmd+Shift+P` or `Ctrl+Shift+P`):
-  - `Gemini CLI: Run`: Starts a new Gemini CLI session in the integrated
-    terminal.
-  - `Gemini CLI: Accept Diff`: Accepts the changes in the active diff editor.
-  - `Gemini CLI: Close Diff Editor`: Rejects the changes and closes the active
-    diff editor.
-  - `Gemini CLI: View Third-Party Notices`: Displays the third-party notices for
-    the extension.
-
-## Installation and setup
-
-There are three ways to set up the IDE integration:
-
-### 1. Automatic nudge (recommended)
-
-When you run Gemini CLI inside a supported editor, it will automatically detect
-your environment and prompt you to connect. Answering "Yes" will automatically
-run the necessary setup, which includes installing the companion extension and
-enabling the connection.
-
-### 2. Manual installation from CLI
-
-If you previously dismissed the prompt or want to install the extension
-manually, you can run the following command inside Gemini CLI:
-
-```
-/ide install
-```
-
-This will find the correct extension for your IDE and install it.
-
-### 3. Manual installation from a marketplace
-
-You can also install the extension directly from a marketplace.
-
-- **For Visual Studio Code:** Install from the
-  [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=google.gemini-cli-vscode-ide-companion).
-- **For VS Code forks:** To support forks of VS Code, the extension is also
-  published on the
-  [Open VSX Registry](https://open-vsx.org/extension/google/gemini-cli-vscode-ide-companion).
-  Follow your editor's instructions for installing extensions from this
-  registry.
-
-> NOTE: The "Gemini CLI Companion" extension may appear towards the bottom of
-> search results. If you don't see it immediately, try scrolling down or sorting
-> by "Newly Published".
->
-> After manually installing the extension, you must run `/ide enable` in the CLI
-> to activate the integration.
-
-## Usage
-
-### Enabling and disabling
-
-You can control the IDE integration from within the CLI:
-
-- To enable the connection to the IDE, run:
-  ```
-  /ide enable
-  ```
-- To disable the connection, run:
-  ```
-  /ide disable
-  ```
-
-When enabled, Gemini CLI will automatically attempt to connect to the IDE
-companion extension.
-
-### Checking the status
-
-To check the connection status and see the context the CLI has received from the
-IDE, run:
-
-```
-/ide status
-```
-
-If connected, this command will show the IDE it's connected to and a list of
-recently opened files it is aware of.
-
-> [!NOTE] The file list is limited to 10 recently accessed files within your
-> workspace and only includes local files on disk.)
-
-### Working with diffs
-
-When you ask Gemini to modify a file, it can open a diff view directly in your
-editor.
-
-**To accept a diff**, you can perform any of the following actions:
-
-- Click the **checkmark icon** in the diff editor's title bar.
-- Save the file (e.g., with `Cmd+S` or `Ctrl+S`).
-- Open the Command Palette and run **Gemini CLI: Accept Diff**.
-- Respond with `yes` in the CLI when prompted.
-
-**To reject a diff**, you can:
-
-- Click the **'x' icon** in the diff editor's title bar.
-- Close the diff editor tab.
-- Open the Command Palette and run **Gemini CLI: Close Diff Editor**.
-- Respond with `no` in the CLI when prompted.
-
-You can also **modify the suggested changes** directly in the diff view before
-accepting them.
-
-If you select ‘Allow for this session’ in the CLI, changes will no longer show
-up in the IDE as they will be auto-accepted.
-
-## Using with sandboxing
-
-If you are using Gemini CLI within a sandbox, please be aware of the following:
-
-- **On macOS:** The IDE integration requires network access to communicate with
-  the IDE companion extension. You must use a Seatbelt profile that allows
-  network access.
-- **In a Docker container:** If you run Gemini CLI inside a Docker (or Podman)
-  container, the IDE integration can still connect to the VS Code extension
-  running on your host machine. The CLI is configured to automatically find the
-  IDE server on `host.docker.internal`. No special configuration is usually
-  required, but you may need to ensure your Docker networking setup allows
-  connections from the container to the host.
-
-## Troubleshooting
-
-If you encounter issues with IDE integration, here are some common error
-messages and how to resolve them.
-
-### Connection errors
-
-- **Message:**
-  `🔴 Disconnected: Failed to connect to IDE companion extension in [IDE Name]. Please ensure the extension is running. To install the extension, run /ide install.`
-  - **Cause:** Gemini CLI could not find the necessary environment variables
-    (`GEMINI_CLI_IDE_WORKSPACE_PATH` or `GEMINI_CLI_IDE_SERVER_PORT`) to connect
-    to the IDE. This usually means the IDE companion extension is not running or
-    did not initialize correctly.
-  - **Solution:**
-    1.  Make sure you have installed the **Gemini CLI Companion** extension in
-        your IDE and that it is enabled.
-    2.  Open a new terminal window in your IDE to ensure it picks up the correct
-        environment.
-
-- **Message:**
-  `🔴 Disconnected: IDE connection error. The connection was lost unexpectedly. Please try reconnecting by running /ide enable`
-  - **Cause:** The connection to the IDE companion was lost.
-  - **Solution:** Run `/ide enable` to try and reconnect. If the issue
-    continues, open a new terminal window or restart your IDE.
-
-### Configuration errors
-
-- **Message:**
-  `🔴 Disconnected: Directory mismatch. Gemini CLI is running in a different location than the open workspace in [IDE Name]. Please run the CLI from one of the following directories: [List of directories]`
-  - **Cause:** The CLI's current working directory is outside the workspace you
-    have open in your IDE.
-  - **Solution:** `cd` into the same directory that is open in your IDE and
-    restart the CLI.
-
-- **Message:**
-  `🔴 Disconnected: To use this feature, please open a workspace folder in [IDE Name] and try again.`
-  - **Cause:** You have no workspace open in your IDE.
-  - **Solution:** Open a workspace in your IDE and restart the CLI.
-
-### General errors
-
-- **Message:**
-  `IDE integration is not supported in your current environment. To use this feature, run Gemini CLI in one of these supported IDEs: [List of IDEs]`
-  - **Cause:** You are running Gemini CLI in a terminal or environment that is
-    not a supported IDE.
-  - **Solution:** Run Gemini CLI from the integrated terminal of a supported
-    IDE, like Antigravity or VS Code.
-
-- **Message:**
-  `No installer is available for IDE. Please install the Gemini CLI Companion extension manually from the marketplace.`
-  - **Cause:** You ran `/ide install`, but the CLI does not have an automated
-    installer for your specific IDE.
-  - **Solution:** Open your IDE's extension marketplace, search for "Gemini CLI
-    Companion", and
-    [install it manually](#3-manual-installation-from-a-marketplace).

package/dist/docs/index.md

@@ -1,153 +0,0 @@
-# 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.
-- **[Agent Skills](./cli/skills.md):** (Experimental) Extend the CLI with
-  specialized expertise and procedural workflows.
-- **[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.
-- **[Long-term memory proposal](./core/long-term-memory-proposal.md):**
-  PostgreSQL 기반 장기 메모리 도입 제안서.
-- **[Long-term memory design](./core/long-term-memory-design.md):** 장기 메모리
-  저장/검색 경로 상세 설계.
-- **[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.
-- **[Writing extensions](./extensions/writing-extensions.md):** Learn how to
-  build your own extension.
-- **[Extension releasing](./extensions/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!

package/dist/docs/integration-tests.md

@@ -1,211 +0,0 @@
-# Integration tests
-
-This document provides information about the integration testing framework used
-in this project.
-
-## Overview
-
-The integration tests are designed to validate the end-to-end functionality of
-the Gemini CLI. They execute the built binary in a controlled environment and
-verify that it behaves as expected when interacting with the file system.
-
-These tests are located in the `integration-tests` directory and are run using a
-custom test runner.
-
-## Building the tests
-
-Prior to running any integration tests, you need to create a release bundle that
-you want to actually test:
-
-```bash
-npm run bundle
-```
-
-You must re-run this command after making any changes to the CLI source code,
-but not after making changes to tests.
-
-## Running the tests
-
-The integration tests are not run as part of the default `npm run test` command.
-They must be run explicitly using the `npm run test:integration:all` script.
-
-The integration tests can also be run using the following shortcut:
-
-```bash
-npm run test:e2e
-```
-
-## Running a specific set of tests
-
-To run a subset of test files, you can use
-`npm run <integration test command> <file_name1> ....` where &lt;integration
-test command&gt; is either `test:e2e` or `test:integration*` and `<file_name>`
-is any of the `.test.js` files in the `integration-tests/` directory. For
-example, the following command runs `list_directory.test.js` and
-`write_file.test.js`:
-
-```bash
-npm run test:e2e list_directory write_file
-```
-
-### Running a single test by name
-
-To run a single test by its name, use the `--test-name-pattern` flag:
-
-```bash
-npm run test:e2e -- --test-name-pattern "reads a file"
-```
-
-### Regenerating model responses
-
-Some integration tests use faked out model responses, which may need to be
-regenerated from time to time as the implementations change.
-
-To regenerate these golden files, set the REGENERATE_MODEL_GOLDENS environment
-variable to "true" when running the tests, for example:
-
-**WARNING**: If running locally you should review these updated responses for
-any information about yourself or your system that gemini may have included in
-these responses.
-
-```bash
-REGENERATE_MODEL_GOLDENS="true" npm run test:e2e
-```
-
-**WARNING**: Make sure you run **await rig.cleanup()** at the end of your test,
-else the golden files will not be updated.
-
-### Deflaking a test
-
-Before adding a **new** integration test, you should test it at least 5 times
-with the deflake script or workflow to make sure that it is not flaky.
-
-### Deflake script
-
-```bash
-npm run deflake -- --runs=5 --command="npm run test:e2e -- -- --test-name-pattern '<your-new-test-name>'"
-```
-
-#### Deflake workflow
-
-```bash
-gh workflow run deflake.yml --ref <your-branch> -f test_name_pattern="<your-test-name-pattern>"
-```
-
-### Running all tests
-
-To run the entire suite of integration tests, use the following command:
-
-```bash
-npm run test:integration:all
-```
-
-### Sandbox matrix
-
-The `all` command will run tests for `no sandboxing`, `docker` and `podman`.
-Each individual type can be run using the following commands:
-
-```bash
-npm run test:integration:sandbox:none
-```
-
-```bash
-npm run test:integration:sandbox:docker
-```
-
-```bash
-npm run test:integration:sandbox:podman
-```
-
-## Diagnostics
-
-The integration test runner provides several options for diagnostics to help
-track down test failures.
-
-### Keeping test output
-
-You can preserve the temporary files created during a test run for inspection.
-This is useful for debugging issues with file system operations.
-
-To keep the test output set the `KEEP_OUTPUT` environment variable to `true`.
-
-```bash
-KEEP_OUTPUT=true npm run test:integration:sandbox:none
-```
-
-When output is kept, the test runner will print the path to the unique directory
-for the test run.
-
-### Verbose output
-
-For more detailed debugging, set the `VERBOSE` environment variable to `true`.
-
-```bash
-VERBOSE=true npm run test:integration:sandbox:none
-```
-
-When using `VERBOSE=true` and `KEEP_OUTPUT=true` in the same command, the output
-is streamed to the console and also saved to a log file within the test's
-temporary directory.
-
-The verbose output is formatted to clearly identify the source of the logs:
-
-```
---- TEST: <log dir>:<test-name> ---
-... output from the gemini command ...
---- END TEST: <log dir>:<test-name> ---
-```
-
-## Linting and formatting
-
-To ensure code quality and consistency, the integration test files are linted as
-part of the main build process. You can also manually run the linter and
-auto-fixer.
-
-### Running the linter
-
-To check for linting errors, run the following command:
-
-```bash
-npm run lint
-```
-
-You can include the `:fix` flag in the command to automatically fix any fixable
-linting errors:
-
-```bash
-npm run lint:fix
-```
-
-## Directory structure
-
-The integration tests create a unique directory for each test run inside the
-`.integration-tests` directory. Within this directory, a subdirectory is created
-for each test file, and within that, a subdirectory is created for each
-individual test case.
-
-This structure makes it easy to locate the artifacts for a specific test run,
-file, or case.
-
-```
-.integration-tests/
-└── <run-id>/
-    └── <test-file-name>.test.js/
-        └── <test-case-name>/
-            ├── output.log
-            └── ...other test artifacts...
-```
-
-## Continuous integration
-
-To ensure the integration tests are always run, a GitHub Actions workflow is
-defined in `.github/workflows/chained_e2e.yml`. This workflow automatically runs
-the integrations tests for pull requests against the `main` branch, or when a
-pull request is added to a merge queue.
-
-The workflow runs the tests in different sandboxing environments to ensure
-Gemini CLI is tested across each:
-
-- `sandbox:none`: Runs the tests without any sandboxing.
-- `sandbox:docker`: Runs the tests in a Docker container.
-- `sandbox:podman`: Runs the tests in a Podman container.