@thacio/auditaria 0.30.12 → 0.30.13

package/bundle/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
+```

package/bundle/docs/index.md

@@ -1,121 +1,169 @@
 # Gemini CLI documentation
 
-Gemini CLI is an open-source AI agent that brings the power of Gemini directly
-into your terminal. It is designed to be a terminal-first, extensible, and
-powerful tool for developers, engineers, SREs, and beyond.
-
-Gemini CLI integrates with your local environment. It can read and edit files,
-execute shell commands, and search the web, all while maintaining your project
+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
 
-Begin your journey with Gemini CLI by setting up your environment and learning
-the basics.
+Jump in to Gemini CLI.
 
-- **[Quickstart](./get-started/index.md):** A streamlined guide to get you
-  chatting in minutes.
-- **[Installation](./get-started/installation.md):** Instructions for macOS,
-  Linux, and Windows.
-- **[Authentication](./get-started/authentication.md):** Set up access using
-  Google OAuth, API keys, or Vertex AI.
-- **[Examples](./get-started/examples.md):** View common usage scenarios to
-  inspire your own workflows.
+- **[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
 
-Master the core capabilities that let Gemini CLI interact with your system
-safely and effectively.
-
-- **[Using the CLI](./cli/index.md):** Learn the basics of the command-line
-  interface.
-- **[File management](./tools/file-system.md):** Grant the model the ability to
-  read code and apply changes directly to your files.
-- **[Shell commands](./tools/shell.md):** Allow the model to run builds, tests,
-  and git commands.
-- **[Memory management](./tools/memory.md):** Teach Gemini CLI facts about your
-  project and preferences that persist across sessions.
-- **[Project context](./cli/gemini-md.md):** Use `GEMINI.md` files to provide
-  persistent context for your projects.
-- **[Web search and fetch](./tools/web-search.md):** Enable the model to fetch
-  real-time information from the internet.
-- **[Session management](./cli/session-management.md):** Save, resume, and
-  organize your chat sessions.
+User-focused guides and tutorials for daily development workflows.
+
+- **[File management](./cli/tutorials/file-management.md):** How to work with
+  local files and directories.
+- **[Get started with Agent skills](./cli/tutorials/skills-getting-started.md):**
+  Getting started with specialized expertise.
+- **[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.
+- **[Set up an MCP server](./cli/tutorials/mcp-setup.md):** Set up an MCP
+  server.
+- **[Automate tasks](./cli/tutorials/automation.md):** Automate tasks.
+
+## 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 🧪](./cli/plan-mode.md):** Use a safe, read-only mode for
+  planning complex changes.
+- **[Remote subagents 🧪](./core/remote-agents.md):** Connecting to and using
+  remote agents.
+- **[Sandboxing](./cli/sandbox.md):** Isolate tool execution.
+- **[Shell (tool)](./tools/shell.md):** Detailed system execution parameters.
+- **[Subagents 🧪](./core/subagents.md):** Using specialized agents for specific
+  tasks.
+- **[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
 
-Customize Gemini CLI to match your workflow and preferences.
-
-- **[Settings](./cli/settings.md):** Control response creativity, output
-  verbosity, and more.
-- **[Model selection](./cli/model.md):** Choose the best Gemini model for your
-  specific task.
-- **[Ignore files](./cli/gemini-ignore.md):** Use `.geminiignore` to keep
-  sensitive files out of the model's context.
-- **[Trusted folders](./cli/trusted-folders.md):** Define security boundaries
-  for file access and execution.
-- **[Token caching](./cli/token-caching.md):** Optimize performance and cost by
-  caching context.
-- **[Themes](./cli/themes.md):** Personalize the visual appearance of the CLI.
-
-## Advanced features
-
-Explore powerful features for complex workflows and enterprise environments.
-
-- **[Headless mode](./cli/headless.md):** Run Gemini CLI in scripts or CI/CD
-  pipelines for automated reasoning.
-- **[Sandboxing](./cli/sandbox.md):** Execute untrusted code or tools in a
-  secure, isolated container.
-- **[Checkpointing](./cli/checkpointing.md):** Save and restore workspace state
-  to recover from experimental changes.
-- **[Custom commands](./cli/custom-commands.md):** Create shortcuts for
-  frequently used prompts.
-- **[System prompt override](./cli/system-prompt.md):** Customize the core
-  instructions given to the model.
-- **[Telemetry](./cli/telemetry.md):** Understand how usage data is collected
-  and managed.
-- **[Enterprise](./cli/enterprise.md):** Manage configurations and policies for
-  large teams.
-
-## Extensions
-
-Extend Gemini CLI's capabilities with new tools and behaviors using extensions.
-
-- **[Introduction](./extensions/index.md):** Learn about the extension system
-  and how to manage extensions.
-- **[Writing extensions](./extensions/writing-extensions.md):** Learn how to
-  create your first extension.
-- **[Extensions reference](./extensions/reference.md):** Deeply understand the
-  extension format, commands, and configuration.
-- **[Best practices](./extensions/best-practices.md):** Learn strategies for
-  building great extensions.
-- **[Extensions releasing](./extensions/releasing.md):** Learn how to share your
-  extensions with the world.
-
-## Ecosystem and extensibility
-
-Connect Gemini CLI to external services and other development tools.
-
-- **[MCP servers](./tools/mcp-server.md):** Connect to external services using
-  the Model Context Protocol.
-- **[IDE integration](./ide-integration/index.md):** Use Gemini CLI alongside VS
-  Code.
-- **[Hooks](./hooks/index.md):** Write scripts that run on specific CLI events.
-- **[Agent skills](./cli/skills.md):** Add specialized expertise and workflows.
-- **[Sub-agents](./core/subagents.md):** (Preview) Delegate tasks to specialized
-  agents.
-
-## Development and reference
-
-Deep dive into the architecture and contribute to the project.
-
-- **[Architecture](./architecture.md):** Understand the technical design of
-  Gemini CLI.
-- **[Command reference](./cli/commands.md):** A complete list of available
-  commands.
-- **[Local development](./local-development.md):** Set up your environment to
-  contribute to Gemini CLI.
-- **[Contributing](../CONTRIBUTING.md):** Learn how to submit pull requests and
-  report issues.
-- **[FAQ](./faq.md):** Answers to common questions.
-- **[Troubleshooting](./troubleshooting.md):** Solutions for common issues.
+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.
+
+- **[Command reference](./cli/commands.md):** Detailed slash command guide.
+- **[Configuration reference](./get-started/configuration.md):** Settings and
+  environment variables.
+- **[Keyboard shortcuts](./cli/keyboard-shortcuts.md):** Productivity tips.
+- **[Memory import processor](./core/memport.md):** How Gemini CLI processes
+  memory from various sources.
+- **[Policy engine](./core/policy-engine.md):** Fine-grained execution control.
+- **[Tools API](./core/tools-api.md):** The API for defining and using tools.
+
+## 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.
+
+## Development
+
+- **[Contribution guide](/docs/contributing):** How to contribute to Gemini CLI.
+- **[Integration testing](./integration-tests.md):** Running integration tests.
+- **[Issue and PR automation](./issue-and-pr-automation.md):** Automation for
+  issues and pull requests.
+- **[Local development](./local-development.md):** Setting up a local
+  development environment.
+- **[NPM package structure](./npm.md):** The structure of the NPM packages.
+
+## Releases
+
+- **[Release notes](./changelogs/index.md):** Release notes for all versions.
+- **[Stable release](./changelogs/latest.md):** The latest stable release.
+- **[Preview release](./changelogs/preview.md):** The latest preview release.

package/bundle/docs/releases.md

@@ -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 @thacio/auditaria@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.