@office-ai/aioncli-core 0.26.0 → 0.30.0

package/dist/docs/get-started/examples.md

@@ -1,13 +1,18 @@
 # Gemini CLI examples
 
-Not sure where to get started with Gemini CLI? This document covers examples on
-how to use Gemini CLI for a variety of tasks.
+Gemini CLI helps you automate common engineering tasks by combining AI reasoning
+with local system tools. This document provides examples of how to use the CLI
+for file management, code analysis, and data transformation.
 
-**Note:** Results are examples intended to showcase potential use cases. Your
-results may vary.
+> **Note:** These examples demonstrate potential capabilities. Your actual
+> results can vary based on the model used and your project environment.
 
 ## Rename your photographs based on content
 
+You can use Gemini CLI to automate file management tasks that require visual
+analysis. In this example, Gemini CLI renames images based on their actual
+subject matter.
+
 Scenario: You have a folder containing the following files:
 
 ```bash
@@ -22,9 +27,9 @@ Give Gemini the following prompt:
 Rename the photos in my "photos" directory based on their contents.
 ```
 
-Result: Gemini will ask for permission to rename your files.
+Result: Gemini asks for permission to rename your files.
 
-Select **Allow once** and your files will be renamed:
+Select **Allow once** and your files are renamed:
 
 ```bash
 photos/yellow_flowers.png
@@ -34,6 +39,9 @@ photos/green_android_robot.png
 
 ## Explain a repository by reading its code
 
+Gemini CLI is effective for rapid codebase exploration. The following example
+shows how to ask Gemini CLI to fetch, analyze, and summarize a remote project.
+
 Scenario: You want to understand how a popular open-source utility works by
 inspecting its code, not just its README.
 
@@ -43,15 +51,14 @@ Give Gemini CLI the following prompt:
 Clone the 'chalk' repository from https://github.com/chalk/chalk, read its key source files, and explain how it works.
 ```
 
-Result: Gemini will perform a sequence of actions to answer your request.
+Result: Gemini performs a sequence of actions to answer your request.
 
-1.  First, it will ask for permission to run `git clone` to download the
-    repository.
-2.  Next, it will find the important source files and ask for permission to read
+1.  First, it asks for permission to run `git clone` to download the repository.
+2.  Next, it finds the important source files and asks for permission to read
     them.
-3.  Finally, after analyzing the code, it will provide a summary.
+3.  Finally, after analyzing the code, it provides a summary.
 
-Gemini CLI will return an explanation based on the actual source code:
+Gemini CLI returns an explanation based on the actual source code:
 
 ```markdown
 The `chalk` library is a popular npm package for styling terminal output with
@@ -74,25 +81,11 @@ colors. After analyzing the source code, here's how it works:
 
 ## Combine two spreadsheets into one spreadsheet
 
-Scenario: You have two .csv files: `Revenue - 2023.csv` and
-`Revenue - 2024.csv`. Each file contains monthly revenue figures, like so:
-
-```csv
-January,0
-February,0
-March,0
-April,900
-May,1000
-June,1000
-July,1200
-August,1800
-September,2000
-October,2400
-November,3400
-December,2100
-```
+Gemini CLI can process and transform data across multiple files. Use this
+capability to merge reports or reformat data sets without manual copying.
 
-You want to combine these two .csv files into a single .csv file.
+Scenario: You have two .csv files: `Revenue - 2023.csv` and
+`Revenue - 2024.csv`. Each file contains monthly revenue figures.
 
 Give Gemini CLI the following prompt:
 
@@ -100,9 +93,8 @@ Give Gemini CLI the following prompt:
 Combine the two .csv files into a single .csv file, with each year a different column.
 ```
 
-Result: Gemini CLI will read each file and then ask for permission to write a
-new file. Provide your permission and Gemini CLI will provide the following
-.csv:
+Result: Gemini CLI reads each file and then asks for permission to write a new
+file. Provide your permission and Gemini CLI provides the combined data:
 
 ```csv
 Month,2023,2024
@@ -122,6 +114,10 @@ December,2100,9000
 
 ## Run unit tests
 
+Gemini CLI can generate boilerplate code and tests based on your existing
+implementation. This example demonstrates how to request code coverage for a
+JavaScript component.
+
 Scenario: You've written a simple login page. You wish to write unit tests to
 ensure that your login page has code coverage.
 
@@ -131,89 +127,13 @@ Give Gemini CLI the following prompt:
 Write unit tests for Login.js.
 ```
 
-Result: Gemini CLI will ask for permission to write a new file and create a test
-for your login page
-
-```javascript
-import React from 'react';
-import { render, fireEvent, waitFor } from '@testing-library/react';
-import Login from './Login';
-
-// Mock the API call for login
-jest.mock('./api', () => ({
-  login: jest.fn(),
-}));
-
-describe('Login component', () => {
-  it('renders the login form correctly', () => {
-    const { getByLabelText, getByText } = render(<Login />);
-
-    expect(getByLabelText('Username')).toBeInTheDocument();
-    expect(getByLabelText('Password')).toBeInTheDocument();
-    expect(getByText('Login')).toBeInTheDocument();
-  });
-
-  it('shows an error message with invalid credentials', async () => {
-    const { getByLabelText, getByText, findByText } = render(<Login />);
-    const usernameInput = getByLabelText('Username');
-    const passwordInput = getByLabelText('Password');
-    const loginButton = getByText('Login');
-
-    // Mock the API to return an error
-    require('./api').login.mockRejectedValue(new Error('Invalid credentials'));
-
-    fireEvent.change(usernameInput, { target: { value: 'testuser' } });
-    fireEvent.change(passwordInput, { target: { value: 'wrongpassword' } });
-    fireEvent.click(loginButton);
-
-    const errorMessage = await findByText('Invalid credentials');
-    expect(errorMessage).toBeInTheDocument();
-  });
-
-  it('logs in successfully with valid credentials', async () => {
-    const onLoginSuccess = jest.fn();
-    const { getByLabelText, getByText } = render(
-      <Login onLoginSuccess={onLoginSuccess} />,
-    );
-    const usernameInput = getByLabelText('Username');
-    const passwordInput = getByLabelText('Password');
-    const loginButton = getByText('Login');
-
-    // Mock the API to return a success message
-    require('./api').login.mockResolvedValue({ success: true });
-
-    fireEvent.change(usernameInput, { target: { value: 'testuser' } });
-    fireEvent.change(passwordInput, { target: { value: 'correctpassword' } });
-    fireEvent.click(loginButton);
-
-    await waitFor(() => {
-      expect(onLoginSuccess).toHaveBeenCalled();
-    });
-  });
-
-  it('disables the submit button while submitting', async () => {
-    const { getByLabelText, getByText } = render(<Login />);
-    const usernameInput = getByLabelText('Username');
-    const passwordInput = getByLabelText('Password');
-    const loginButton = getByText('Login');
-
-    // Mock the API to have a delay
-    require('./api').login.mockImplementation(
-      () =>
-        new Promise((resolve) =>
-          setTimeout(() => resolve({ success: true }), 1000),
-        ),
-    );
-
-    fireEvent.change(usernameInput, { target: { value: 'testuser' } });
-    fireEvent.change(passwordInput, { target: { value: 'correctpassword' } });
-    fireEvent.click(loginButton);
-
-    expect(loginButton).toBeDisabled();
-
-    await waitFor(() => {
-      expect(loginButton).not.toBeDisabled();
-    });
-  });
-});
-```
+Result: Gemini CLI asks for permission to write a new file and creates a test
+for your login page.
+
+## Next steps
+
+- Explore the [User guides](../cli/index.md#user-guides) for detailed
+  walkthroughs of common tasks.
+- Follow the [Quickstart](./index.md) to start your first session.
+- See the [Cheatsheet](../cli/cli-reference.md) for a quick reference of
+  available commands.

package/dist/docs/get-started/gemini-3.md

@@ -1,25 +1,10 @@
 # Gemini 3 Pro and Gemini 3 Flash on Gemini CLI
 
-Gemini 3 Pro and Gemini 3 Flash are now available on Gemini CLI! Currently, most
-paid customers of Gemini CLI will have access to both Gemini 3 Pro and Gemini 3
-Flash, including the following subscribers:
-
-- Google AI Pro and Google AI Ultra (excluding business customers).
-- Gemini Code Assist Standard and Enterprise (requires
-  [administrative enablement](#administrator-instructions)).
-- Paid Gemini API and Vertex API key holders.
-
-For free tier users:
-
-- If you signed up for the waitlist, please check your email for details. We’ve
-  onboarded everyone who signed up to the previously available waitlist.
-- If you were not on our waitlist, we’re rolling out additional access gradually
-  to ensure the experience remains fast and reliable. Stay tuned for more
-  details.
+Gemini 3 Pro and Gemini 3 Flash are available on Gemini CLI for all users!
 
 ## How to get started with Gemini 3 on Gemini CLI
 
-Get started by upgrading Gemini CLI to the latest version (0.21.1):
+Get started by upgrading Gemini CLI to the latest version:
 
 ```bash
 npm install -g @google/gemini-cli@latest

package/dist/docs/get-started/index.md

@@ -64,8 +64,10 @@ and more.
 
 To explore the power of Gemini CLI, see [Gemini CLI examples](./examples.md).
 
-## What's next?
+## Next steps
 
-- Find out more about [Gemini CLI's tools](../tools/index.md).
-- Review [Gemini CLI's commands](../cli/commands.md).
-- Learn how to [get started with Gemini 3](./gemini-3.md).
+- Follow the [File management](../cli/tutorials/file-management.md) guide to
+  start working with your codebase.
+- See [Shell commands](../cli/tutorials/shell-commands.md) to learn about
+  terminal integration.
+- Explore the full range of [User guides](../cli/index.md#user-guides).

package/dist/docs/get-started/installation.md

@@ -1,43 +1,98 @@
-# Gemini CLI installation, execution, and deployment
+# Gemini CLI installation, execution, and releases
 
-Install and run Gemini CLI. This document provides an overview of Gemini CLI's
-installation methods and deployment architecture.
+This document provides an overview of Gemini CLI's sytem requriements,
+installation methods, and release types.
 
-## How to install and/or run Gemini CLI
+## Recommended system specifications
 
-There are several ways to run Gemini CLI. The recommended option depends on how
-you intend to use Gemini CLI.
+- **Operating System:**
+  - macOS 15+
+  - Windows 11 24H2+
+  - Ubuntu 20.04+
+- **Hardware:**
+  - "Casual" usage: 4GB+ RAM (short sessions, common tasks and edits)
+  - "Power" usage: 16GB+ RAM (long sessions, large codebases, deep context)
+- **Runtime:** Node.js 20.0.0+
+- **Shell:** Bash or Zsh
+- **Location:**
+  [Gemini Code Assist supported locations](https://developers.google.com/gemini-code-assist/resources/available-locations#americas)
+- **Internet connection required**
 
-- As a standard installation. This is the most straightforward method of using
-  Gemini CLI.
-- In a sandbox. This method offers increased security and isolation.
-- From the source. This is recommended for contributors to the project.
+## Install Gemini CLI
 
-### 1. Standard installation (recommended for standard users)
+We recommend most users install Gemini CLI using one of the following
+installation methods:
 
-This is the recommended way for end-users to install Gemini CLI. It involves
-downloading the Gemini CLI package from the NPM registry.
+- npm
+- Homebrew
+- MacPorts
+- Anaconda
 
-- **Global install:**
+Note that Gemini CLI comes pre-installed on
+[**Cloud Shell**](https://docs.cloud.google.com/shell/docs) and
+[**Cloud Workstations**](https://cloud.google.com/workstations).
 
-  ```bash
-  npm install -g @google/gemini-cli
-  ```
+### Install globally with npm
 
-  Then, run the CLI from anywhere:
+```bash
+npm install -g @google/gemini-cli
+```
 
-  ```bash
-  gemini
-  ```
+### Install globally with Homebrew (macOS/Linux)
 
-- **NPX execution:**
+```bash
+brew install gemini-cli
+```
 
-  ```bash
-  # Execute the latest version from NPM without a global install
-  npx @google/gemini-cli
-  ```
+### Install globally with MacPorts (macOS)
+
+```bash
+sudo port install gemini-cli
+```
+
+### Install with Anaconda (for restricted environments)
+
+```bash
+# Create and activate a new environment
+conda create -y -n gemini_env -c conda-forge nodejs
+conda activate gemini_env
+
+# Install Gemini CLI globally via npm (inside the environment)
+npm install -g @google/gemini-cli
+```
 
-### 2. Run in a sandbox (Docker/Podman)
+## Run Gemini CLI
+
+For most users, we recommend running Gemini CLI with the `gemini` command:
+
+```bash
+gemini
+```
+
+For a list of options and additional commands, see the
+[CLI cheatsheet](/docs/cli/cli-reference.md).
+
+You can also run Gemini CLI using one of the following advanced methods:
+
+- Run instantly with npx. You can run Gemini CLI without permanent installation.
+- In a sandbox. This method offers increased security and isolation.
+- From the source. This is recommended for contributors to the project.
+
+### Run instantly with npx
+
+```bash
+# Using npx (no installation required)
+npx @google/gemini-cli
+```
+
+You can also execute the CLI directly from the main branch on GitHub, which is
+helpful for testing features still in development:
+
+```bash
+npx https://github.com/google-gemini/gemini-cli
+```
+
+### Run in a sandbox (Docker/Podman)
 
 For security and isolation, Gemini CLI can be run inside a container. This is
 the default way that the CLI executes tools that might have side effects.
@@ -56,7 +111,7 @@ the default way that the CLI executes tools that might have side effects.
   gemini --sandbox -y -p "your prompt here"
   ```
 
-### 3. Run from source (recommended for Gemini CLI contributors)
+### Run from source (recommended for Gemini CLI contributors)
 
 Contributors to the project will want to run the CLI directly from the source
 code.
@@ -79,63 +134,41 @@ code.
   gemini
   ```
 
----
+## Releases
+
+Gemini CLI has three release channels: nightly, preview, and stable. For most
+users, we recommend the stable release, which is the default installation.
 
-### 4. Running the latest Gemini CLI commit from GitHub
+### Stable
 
-You can run the most recently committed version of Gemini CLI directly from the
-GitHub repository. This is useful for testing features still in development.
+New stable releases are published each week. The stable release is the promotion
+of last week's `preview` release along with any bug fixes. The stable release
+uses `latest` tag, but omitting the tag also installs the latest stable release
+by default:
 
 ```bash
-# Execute the CLI directly from the main branch on GitHub
-npx https://github.com/google-gemini/gemini-cli
+# Both commands install the latest stable release.
+npm install -g @google/gemini-cli
+npm install -g @google/gemini-cli@latest
 ```
 
-## Deployment architecture
+### Preview
 
-The execution methods described above are made possible by the following
-architectural components and processes:
+New preview releases will be published each week. These releases are not fully
+vetted and may contain regressions or other outstanding issues. Try out the
+preview release by using the `preview` tag:
 
-**NPM packages**
-
-Gemini CLI project is a monorepo that publishes two core packages to the NPM
-registry:
-
-- `@google/gemini-cli-core`: The backend, handling logic and tool execution.
-- `@google/gemini-cli`: The user-facing frontend.
-
-These packages are used when performing the standard installation and when
-running Gemini CLI from the source.
-
-**Build and packaging processes**
-
-There are two distinct build processes used, depending on the distribution
-channel:
-
-- **NPM publication:** For publishing to the NPM registry, the TypeScript source
-  code in `@google/gemini-cli-core` and `@google/gemini-cli` is transpiled into
-  standard JavaScript using the TypeScript Compiler (`tsc`). The resulting
-  `dist/` directory is what gets published in the NPM package. This is a
-  standard approach for TypeScript libraries.
-
-- **GitHub `npx` execution:** When running the latest version of Gemini CLI
-  directly from GitHub, a different process is triggered by the `prepare` script
-  in `package.json`. This script uses `esbuild` to bundle the entire application
-  and its dependencies into a single, self-contained JavaScript file. This
-  bundle is created on-the-fly on the user's machine and is not checked into the
-  repository.
-
-**Docker sandbox image**
-
-The Docker-based execution method is supported by the `gemini-cli-sandbox`
-container image. This image is published to a container registry and contains a
-pre-installed, global version of Gemini CLI.
+```bash
+npm install -g @google/gemini-cli@preview
+```
 
-## Release process
+### Nightly
 
-The release process is automated through GitHub Actions. The release workflow
-performs the following actions:
+Nightly releases are published every day. The nightly release includes all
+changes from the main branch at time of release. It should be assumed there are
+pending validations and issues. You can help test the latest changes by
+installing with the `nightly` tag:
 
-1.  Build the NPM packages using `tsc`.
-2.  Publish the NPM packages to the artifact registry.
-3.  Create GitHub releases with bundled assets.
+```bash
+npm install -g @google/gemini-cli@nightly
+```