jcarr
/
gemini-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update configuration.md with new CLI options (#1360)

This commit is contained in:
cperry-goog 2025-06-23 17:24:55 -07:00 committed by GitHub
parent 3012684469
commit b3741f7016
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/cli/configuration.md
View File

@ -153,7 +153,7 @@ In addition to a project settings file, a project's `.gemini` directory can cont
- **Description:** Configures the checkpointing feature, which allows you to save and restore conversation and file states. See the [Checkpointing Commands](./commands.md#checkpointing-commands) for more details. - **Description:** Configures the checkpointing feature, which allows you to save and restore conversation and file states. See the [Checkpointing Commands](./commands.md#checkpointing-commands) for more details.
- **Default:** `{"enabled": false}` - **Default:** `{"enabled": false}`
- **Properties:** - **Properties:**
- **`enabled`** (boolean): When `true`, the `/save`, `/resume`, and `/restore` commands are available. - **`enabled`** (boolean): When `true`, the `/restore` command is available.
- **`preferredEditor`** (string): - **`preferredEditor`** (string):
@ -281,19 +281,37 @@ The CLI automatically loads environment variables from an `.env` file. The loadi
Arguments passed directly when running the CLI can override other configurations for that specific session. Arguments passed directly when running the CLI can override other configurations for that specific session.
- **`--model <model_name>`** (or **`-m <model_name>`**): - **`--model <model_name>`** (**`-m <model_name>`**):
- Specifies the Gemini model to use for this session. - Specifies the Gemini model to use for this session.
- Example: `npm start -- --model gemini-1.5-pro-latest` - Example: `npm start -- --model gemini-1.5-pro-latest`
- **`--sandbox`** (or **`-s`**): - **`--prompt <your_prompt>`** (**`-p <your_prompt>`**):
- Enables sandbox mode for this session. The exact behavior might depend on other sandbox configurations (environment variables, settings files). - Used to pass a prompt directly to the command. This invokes Gemini CLI in a non-interactive mode.
- **`--debug_mode`** (or **`-d`**): - **`--sandbox`** (**`-s`**):
- Enables sandbox mode for this session.
- **`--sandbox-image`**:
- Sets the sandbox image URI.
- **`--debug_mode`** (**`-d`**):
- Enables debug mode for this session, providing more verbose output. - Enables debug mode for this session, providing more verbose output.
- **`--question <your_question>`** (or **`-q <your_question>`**): - **`--all_files`** (**`-a`**):
- Used to pass a question directly to the command, especially when piping input to the CLI.
- **`--all_files`** (or **`-a`**):
- If set, recursively includes all files within the current directory as context for the prompt. - If set, recursively includes all files within the current directory as context for the prompt.
- **`--help`** (or **`-h`**): - **`--help`** (or **`-h`**):
- Displays help information about command-line arguments. - Displays help information about command-line arguments.
- **`--show_memory_usage`**:
- Displays the current memory usage.
- **`--yolo`**:
- Enables YOLO mode, which automatically approves all tool calls.
- **`--telemetry`**:
- Enables [telemetry](../core/telemetry.md).
- **`--telemetry-target`**:
- Sets the telemetry target. See [telemetry](../core/telemetry.md) for more information.
- **`--telemetry-otlp-endpoint`**:
- Sets the OTLP endpoint for telemetry. See [telemetry](../core/telemetry.md) for more information.
- **`--telemetry-log-prompts`**:
- Enables logging of prompts for telemetry. See [telemetry](../core/telemetry.md) for more information.
- **`--checkpointing`**:
- Enables [checkpointing](./commands.md#checkpointing-commands).
- **`--version`**:
- Displays the version of the CLI.
## Context Files (Hierarchical Instructional Context) ## Context Files (Hierarchical Instructional Context)