@thacio/auditaria 0.30.12 → 0.30.13

package/bundle/docs/get-started/configuration.md

@@ -1,19 +1,8 @@
-# Auditaria configuration
-
-> **Note on configuration format, 9/17/25:** The format of the `settings.json`
-> file has been updated to a new, more organized structure.
->
-> - The new format will be supported in the stable release starting
->   **[09/10/25]**.
-> - Automatic migration from the old format to the new format will begin on
->   **[09/17/25]**.
->
-> For details on the previous format, please see the
-> [v1 Configuration documentation](./configuration-v1.md).
-
-Auditaria offers several ways to configure its behavior, including environment
-variables, command-line arguments, and settings files. This document outlines
-the different configuration methods and available settings.
+# Auditaria CLI configuration
+
+Auditaria CLI offers several ways to configure its behavior, including
+environment variables, command-line arguments, and settings files. This document
+outlines the different configuration methods and available settings.
 
 ## Configuration layers
 
@@ -33,8 +22,8 @@ overridden by higher numbers):
 
 ## Settings files
 
-Auditaria uses JSON settings files for persistent configuration. There are four
-locations for these files:
+Auditaria CLI uses JSON settings files for persistent configuration. There are
+four locations for these files:
 
 > **Tip:** JSON-aware editors can use autocomplete and validation by pointing to
 > the generated schema at `schemas/settings.schema.json` in this repository.
@@ -52,22 +41,22 @@ locations for these files:
     user, project, or system override settings.
 - **User settings file:**
   - **Location:** `~/.gemini/settings.json` (where `~` is your home directory).
-  - **Scope:** Applies to all Auditaria sessions for the current user. User
+  - **Scope:** Applies to all Auditaria CLI sessions for the current user. User
     settings override system defaults.
 - **Project settings file:**
   - **Location:** `.gemini/settings.json` within your project's root directory.
-  - **Scope:** Applies only when running Auditaria from that specific project.
-    Project settings override user settings and system defaults.
+  - **Scope:** Applies only when running Auditaria CLI from that specific
+    project. Project settings override user settings and system defaults.
 - **System settings file:**
   - **Location:** `/etc/gemini-cli/settings.json` (Linux),
     `C:\ProgramData\gemini-cli\settings.json` (Windows) or
     `/Library/Application Support/GeminiCli/settings.json` (macOS). The path can
     be overridden using the `GEMINI_CLI_SYSTEM_SETTINGS_PATH` environment
     variable.
-  - **Scope:** Applies to all Auditaria sessions on the system, for all users.
-    System settings act as overrides, taking precedence over all other settings
-    files. May be useful for system administrators at enterprises to have
-    controls over users' Auditaria setups.
+  - **Scope:** Applies to all Auditaria CLI sessions on the system, for all
+    users. System settings act as overrides, taking precedence over all other
+    settings files. May be useful for system administrators at enterprises to
+    have controls over users' Auditaria CLI setups.
 
 **Note on environment variables in settings:** String values within your
 `settings.json` and `gemini-extension.json` files can reference environment
@@ -77,14 +66,15 @@ an environment variable `MY_API_TOKEN`, you could use it in `settings.json` like
 this: `"apiKey": "$MY_API_TOKEN"`. Additionally, each extension can have its own
 `.env` file in its directory, which will be loaded automatically.
 
-> **Note for Enterprise Users:** For guidance on deploying and managing Gemini
-> CLI in a corporate environment, please see the
+> **Note for Enterprise Users:** For guidance on deploying and managing
+> Auditaria CLI in a corporate environment, please see the
 > [Enterprise Configuration](../cli/enterprise.md) documentation.
 
 ### The `.gemini` directory in your project
 
 In addition to a project settings file, a project's `.gemini` directory can
-contain other project-specific files related to Auditaria's operation, such as:
+contain other project-specific files related to Auditaria CLI's operation, such
+as:
 
 - [Custom sandbox profiles](#sandboxing) (e.g.,
   `.gemini/sandbox-macos-custom.sb`, `.gemini/sandbox.Dockerfile`).
@@ -96,6 +86,13 @@ their corresponding top-level category object in your `settings.json` file.
 
 <!-- SETTINGS-AUTOGEN:START -->
 
+#### `policyPaths`
+
+- **`policyPaths`** (array):
+  - **Description:** Additional policy files or directories to load.
+  - **Default:** `[]`
+  - **Requires restart:** Yes
+
 #### `general`
 
 - **`general.preferredEditor`** (string):
@@ -125,6 +122,11 @@ their corresponding top-level category object in your `settings.json` file.
   - **Description:** Enable update notification prompts.
   - **Default:** `true`
 
+- **`general.enableNotifications`** (boolean):
+  - **Description:** Enable run-event notifications for action-required prompts
+    and session completion. Currently macOS only.
+  - **Default:** `false`
+
 - **`general.checkpointing.enabled`** (boolean):
   - **Description:** Enable session checkpointing for recovery
   - **Default:** `false`
@@ -150,8 +152,8 @@ their corresponding top-level category object in your `settings.json` file.
   - **Default:** `false`
 
 - **`general.sessionRetention.maxAge`** (string):
-  - **Description:** Maximum age of sessions to keep (e.g., "30d", "7d", "24h",
-    "1w")
+  - **Description:** Automatically delete chats older than this time period
+    (e.g., "30d", "7d", "24h", "1w")
   - **Default:** `undefined`
 
 - **`general.sessionRetention.maxCount`** (number):
@@ -163,6 +165,11 @@ their corresponding top-level category object in your `settings.json` file.
   - **Description:** Minimum retention period (safety limit, defaults to "1d")
   - **Default:** `"1d"`
 
+- **`general.sessionRetention.warningAcknowledged`** (boolean):
+  - **Description:** INTERNAL: Whether the user has acknowledged the session
+    retention warning
+  - **Default:** `false`
+
 #### `output`
 
 - **`output.format`** (enum):
@@ -201,8 +208,8 @@ their corresponding top-level category object in your `settings.json` file.
   - **Values:** `"off"`, `"full"`
 
 - **`ui.showStatusInTitle`** (boolean):
-  - **Description:** Show Auditaria model thoughts in the terminal window title
-    during the working phase
+  - **Description:** Show Auditaria CLI model thoughts in the terminal window
+    title during the working phase
   - **Default:** `false`
 
 - **`ui.dynamicWindowTitle`** (boolean):
@@ -211,11 +218,16 @@ their corresponding top-level category object in your `settings.json` file.
   - **Default:** `true`
 
 - **`ui.showHomeDirectoryWarning`** (boolean):
-  - **Description:** Show a warning when running Gemini CLI in the home
+  - **Description:** Show a warning when running Auditaria CLI in the home
     directory.
   - **Default:** `true`
   - **Requires restart:** Yes
 
+- **`ui.showCompatibilityWarnings`** (boolean):
+  - **Description:** Show warnings about terminal or OS compatibility issues.
+  - **Default:** `true`
+  - **Requires restart:** Yes
+
 - **`ui.hideTips`** (boolean):
   - **Description:** Hide helpful tips in the UI
   - **Default:** `false`
@@ -478,6 +490,19 @@ their corresponding top-level category object in your `settings.json` file.
           }
         }
       },
+      "fast-ack-helper": {
+        "extends": "base",
+        "modelConfig": {
+          "model": "gemini-2.5-flash-lite",
+          "generateContentConfig": {
+            "temperature": 0.2,
+            "maxOutputTokens": 120,
+            "thinkingConfig": {
+              "thinkingBudget": 0
+            }
+          }
+        }
+      },
       "edit-corrector": {
         "extends": "base",
         "modelConfig": {
@@ -621,6 +646,11 @@ their corresponding top-level category object in your `settings.json` file.
   - **Description:** The format to use when importing memory.
   - **Default:** `undefined`
 
+- **`context.includeDirectoryTree`** (boolean):
+  - **Description:** Whether to include the directory tree of the current
+    working directory in the initial request to the model.
+  - **Default:** `true`
+
 - **`context.discoveryMaxDirs`** (number):
   - **Description:** Maximum number of directories to search for memory.
   - **Default:** `200`
@@ -912,8 +942,15 @@ their corresponding top-level category object in your `settings.json` file.
   - **Requires restart:** Yes
 
 - **`experimental.useOSC52Paste`** (boolean):
-  - **Description:** Use OSC 52 sequence for pasting instead of clipboardy
-    (useful for remote sessions).
+  - **Description:** Use OSC 52 for pasting. This may be more robust than the
+    default system when using remote terminal sessions (if your terminal is
+    configured to allow it).
+  - **Default:** `false`
+
+- **`experimental.useOSC52Copy`** (boolean):
+  - **Description:** Use OSC 52 for copying. This may be more robust than the
+    default system when using remote terminal sessions (if your terminal is
+    configured to allow it).
   - **Default:** `false`
 
 - **`experimental.plan`** (boolean):
@@ -921,6 +958,11 @@ their corresponding top-level category object in your `settings.json` file.
   - **Default:** `false`
   - **Requires restart:** Yes
 
+- **`experimental.modelSteering`** (boolean):
+  - **Description:** Enable model steering (user hints) to guide the model
+    during tool execution.
+  - **Default:** `false`
+
 #### `skills`
 
 - **`skills.enabled`** (boolean):
@@ -1034,7 +1076,7 @@ their corresponding top-level category object in your `settings.json` file.
 #### `mcpServers`
 
 Configures connections to one or more Model-Context Protocol (MCP) servers for
-discovering and using custom tools. Auditaria attempts to connect to each
+discovering and using custom tools. Auditaria CLI attempts to connect to each
 configured MCP server to discover available tools. If multiple MCP servers
 expose a tool with the same name, the tool names will be prefixed with the
 server alias you defined in the configuration (e.g.,
@@ -1076,8 +1118,8 @@ specified, the order of precedence is `httpUrl`, then `url`, then `command`.
 
 #### `telemetry`
 
-Configures logging and metrics collection for Auditaria. For more information,
-see [Telemetry](../cli/telemetry.md).
+Configures logging and metrics collection for Auditaria CLI. For more
+information, see [Telemetry](../cli/telemetry.md).
 
 - **Properties:**
   - **`enabled`** (boolean): Whether or not telemetry is enabled.
@@ -1208,8 +1250,8 @@ the `advanced.excludedEnvVars` setting in your `settings.json` file.
   - Overrides the hardcoded default
   - Example: `export GEMINI_MODEL="gemini-3-flash-preview"`
 - **`GEMINI_CLI_HOME`**:
-  - Specifies the root directory for Gemini CLI's user-level configuration and
-    storage.
+  - Specifies the root directory for Auditaria CLI's user-level configuration
+    and storage.
   - By default, this is the user's system home directory. The CLI will create a
     `.gemini` folder inside this directory.
   - Useful for shared compute environments or keeping CLI state isolated.
@@ -1314,10 +1356,10 @@ the `advanced.excludedEnvVars` setting in your `settings.json` file.
 
 ### Environment variable redaction
 
-To prevent accidental leakage of sensitive information, Gemini CLI automatically
-redacts potential secrets from environment variables when executing tools (such
-as shell commands). This "best effort" redaction applies to variables inherited
-from the system or loaded from `.env` files.
+To prevent accidental leakage of sensitive information, Auditaria CLI
+automatically redacts potential secrets from environment variables when
+executing tools (such as shell commands). This "best effort" redaction applies
+to variables inherited from the system or loaded from `.env` files.
 
 **Default Redaction Rules:**
 
@@ -1367,10 +1409,9 @@ for that specific session.
   - Specifies the Gemini model to use for this session.
   - Example: `npm start -- --model gemini-3-pro-preview`
 - **`--prompt <your_prompt>`** (**`-p <your_prompt>`**):
-  - Used to pass a prompt directly to the command. This invokes Auditaria in a
-    non-interactive mode.
-  - For scripting examples, use the `--output-format json` flag to get
-    structured output.
+  - **Deprecated:** Use positional arguments instead.
+  - Used to pass a prompt directly to the command. This invokes Auditaria CLI in
+    a non-interactive mode.
 - **`--prompt-interactive <your_prompt>`** (**`-i <your_prompt>`**):
   - Starts an interactive session with the provided prompt as the initial input.
   - The prompt is processed within the interactive session, not before it.
@@ -1423,20 +1464,21 @@ for that specific session.
   - Resume a previous chat session. Use "latest" for the most recent session,
     provide a session index number, or provide a full session UUID.
   - If no session_id is provided, defaults to "latest".
-  - Example: `gemini --resume 5` or `gemini --resume latest` or
-    `gemini --resume a1b2c3d4-e5f6-7890-abcd-ef1234567890` or `gemini --resume`
+  - Example: `auditaria --resume 5` or `auditaria --resume latest` or
+    `auditaria --resume a1b2c3d4-e5f6-7890-abcd-ef1234567890` or
+    `auditaria --resume`
   - See [Session Management](../cli/session-management.md) for more details.
 - **`--list-sessions`**:
   - List all available chat sessions for the current project and exit.
   - Shows session indices, dates, message counts, and preview of first user
     message.
-  - Example: `gemini --list-sessions`
+  - Example: `auditaria --list-sessions`
 - **`--delete-session <identifier>`**:
   - Delete a specific chat session by its index number or full session UUID.
   - Use `--list-sessions` first to see available sessions, their indices, and
     UUIDs.
-  - Example: `gemini --delete-session 3` or
-    `gemini --delete-session a1b2c3d4-e5f6-7890-abcd-ef1234567890`
+  - Example: `auditaria --delete-session 3` or
+    `auditaria --delete-session a1b2c3d4-e5f6-7890-abcd-ef1234567890`
 - **`--include-directories <dir1,dir2,...>`**:
   - Includes additional directories in the workspace for multi-directory
     support.
@@ -1559,12 +1601,12 @@ conventions and context.
 
 By understanding and utilizing these configuration layers and the hierarchical
 nature of context files, you can effectively manage the AI's memory and tailor
-the Auditaria's responses to your specific needs and projects.
+the Auditaria CLI's responses to your specific needs and projects.
 
 ## Sandboxing
 
-The Auditaria can execute potentially unsafe operations (like shell commands and
-file modifications) within a sandboxed environment to protect your system.
+The Auditaria CLI can execute potentially unsafe operations (like shell commands
+and file modifications) within a sandboxed environment to protect your system.
 
 Sandboxing is disabled by default, but you can enable it in a few ways:
 
@@ -1588,17 +1630,17 @@ FROM gemini-cli-sandbox
 ```
 
 When `.gemini/sandbox.Dockerfile` exists, you can use `BUILD_SANDBOX`
-environment variable when running Auditaria to automatically build the custom
-sandbox image:
+environment variable when running Auditaria CLI to automatically build the
+custom sandbox image:
 
 ```bash
-BUILD_SANDBOX=1 auditaria -s
+BUILD_SANDBOX=1 gemini -s
 ```
 
 ## Usage statistics
 
-To help us improve the Auditaria, we collect anonymized usage statistics. This
-data helps us understand how the CLI is used, identify common issues, and
+To help us improve the Auditaria CLI, we collect anonymized usage statistics.
+This data helps us understand how the CLI is used, identify common issues, and
 prioritize new features.
 
 **What we collect:**

package/bundle/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
+
+- Follow the [File management](../cli/tutorials/file-management.md) guide to
+  start working with your codebase.
+- 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/bundle/docs/get-started/index.md

@@ -64,8 +64,9 @@ 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.