diff --git a/docs/extensions/index.md b/docs/extensions/index.md index 84d116cfe6..2c8bc9b22e 100644 --- a/docs/extensions/index.md +++ b/docs/extensions/index.md @@ -42,16 +42,19 @@ installed on your machine. See for help. ``` -gemini extensions install https://github.com/gemini-cli-extensions/security +gemini extensions install [--ref ] [--auto-update] [--pre-release] [--consent] ``` -This will install the Gemini CLI Security extension, which offers support for a -`/security:analyze` command. +- ``: The github URL or local path of the extension to install. +- `--ref`: The git ref to install from. +- `--auto-update`: Enable auto-update for this extension. +- `--pre-release`: Enable pre-release versions for this extension. +- `--consent`: Acknowledge the security risks of installing an extension and + skip the confirmation prompt. ### Uninstalling an extension -To uninstall, run `gemini extensions uninstall extension-name`, so, in the case -of the install example: +To uninstall, run `gemini extensions uninstall `: ``` gemini extensions uninstall gemini-cli-security @@ -62,27 +65,31 @@ gemini extensions uninstall gemini-cli-security Extensions are, by default, enabled across all workspaces. You can disable an extension entirely or for specific workspace. -For example, `gemini extensions disable extension-name` will disable the -extension at the user level, so it will be disabled everywhere. -`gemini extensions disable extension-name --scope=workspace` will only disable -the extension in the current workspace. +``` +gemini extensions disable [--scope ] +``` + +- ``: The name of the extension to disable. +- `--scope`: The scope to disable the extension in (`user` or `workspace`). ### Enabling an extension -You can enable extensions using `gemini extensions enable extension-name`. You -can also enable an extension for a specific workspace using -`gemini extensions enable extension-name --scope=workspace` from within that -workspace. +You can enable extensions using `gemini extensions enable `. You can also +enable an extension for a specific workspace using +`gemini extensions enable --scope=workspace` from within that workspace. -This is useful if you have an extension disabled at the top-level and only -enabled in specific places. +``` +gemini extensions enable [--scope ] +``` + +- ``: The name of the extension to enable. +- `--scope`: The scope to enable the extension in (`user` or `workspace`). ### Updating an extension For extensions installed from a local path or a git repository, you can explicitly update to the latest version (as reflected in the -`gemini-extension.json` `version` field) with -`gemini extensions update extension-name`. +`gemini-extension.json` `version` field) with `gemini extensions update `. You can update all extensions with: @@ -90,10 +97,6 @@ You can update all extensions with: gemini extensions update --all ``` -## Extension creation - -We offer commands to make extension development easier. - ### Create a boilerplate extension We offer several example extensions `context`, `custom-commands`, @@ -104,9 +107,12 @@ To copy one of these examples into a development directory using the type of your choosing, run: ``` -gemini extensions new path/to/directory custom-commands +gemini extensions new [template] ``` +- ``: The path to create the extension in. +- `[template]`: The boilerplate template to use. + ### Link a local extension The `gemini extensions link` command will create a symbolic link from the @@ -116,9 +122,11 @@ This is useful so you don't have to run `gemini extensions update` every time you make changes you'd like to test. ``` -gemini extensions link path/to/directory +gemini extensions link ``` +- ``: The path of the extension to link. + ## How it works On startup, Gemini CLI looks for extensions in `/.gemini/extensions` diff --git a/docs/get-started/configuration.md b/docs/get-started/configuration.md index ec944d2c1e..cc853b6039 100644 --- a/docs/get-started/configuration.md +++ b/docs/get-started/configuration.md @@ -736,15 +736,11 @@ for that specific session. `--output-format json` or `--output-format stream-json` flag. - **`--sandbox`** (**`-s`**): - Enables sandbox mode for this session. -- **`--sandbox-image`**: - - Sets the sandbox image URI. - **`--debug`** (**`-d`**): - Enables debug mode for this session, providing more verbose output. - **`--help`** (or **`-h`**): - 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. - **`--approval-mode `**: @@ -760,22 +756,6 @@ for that specific session. - A comma-separated list of tool names that will bypass the confirmation dialog. - Example: `gemini --allowed-tools "ShellTool(git status)"` -- **`--telemetry`**: - - Enables [telemetry](../cli/telemetry.md). -- **`--telemetry-target`**: - - Sets the telemetry target. See [telemetry](../cli/telemetry.md) for more - information. -- **`--telemetry-otlp-endpoint`**: - - Sets the OTLP endpoint for telemetry. See [telemetry](../cli/telemetry.md) - for more information. -- **`--telemetry-otlp-protocol`**: - - Sets the OTLP protocol for telemetry (`grpc` or `http`). Defaults to `grpc`. - See [telemetry](../cli/telemetry.md) for more information. -- **`--telemetry-log-prompts`**: - - Enables logging of prompts for telemetry. See - [telemetry](../cli/telemetry.md) for more information. -- **`--checkpointing`**: - - Enables [checkpointing](../cli/checkpointing.md). - **`--extensions `** (**`-e `**): - Specifies a list of extensions to use for the session. If not provided, all available extensions are used. @@ -783,9 +763,6 @@ for that specific session. - Example: `gemini -e my-extension -e my-other-extension` - **`--list-extensions`** (**`-l`**): - Lists all available extensions and exits. -- **`--proxy`**: - - Sets the proxy for the CLI. - - Example: `--proxy http://localhost:7890`. - **`--include-directories `**: - Includes additional directories in the workspace for multi-directory support. @@ -798,6 +775,14 @@ for that specific session. with screen readers. - **`--version`**: - Displays the version of the CLI. +- **`--experimental-acp`**: + - Starts the agent in ACP mode. +- **`--allowed-mcp-server-names`**: + - Allowed MCP server names. +- **`--fake-responses`**: + - Path to a file with fake model responses for testing. +- **`--record-responses`**: + - Path to a file to record model responses for testing. ## Context Files (Hierarchical Instructional Context) diff --git a/docs/tools/mcp-server.md b/docs/tools/mcp-server.md index 58afc50d92..3436f7fc31 100644 --- a/docs/tools/mcp-server.md +++ b/docs/tools/mcp-server.md @@ -969,7 +969,8 @@ gemini mcp add --transport sse --header "Authorization: Bearer abc123" secure-ss ### Listing Servers (`gemini mcp list`) To view all MCP servers currently configured, use the `list` command. It -displays each server's name, configuration details, and connection status. +displays each server's name, configuration details, and connection status. This +command has no flags. **Command:** @@ -996,6 +997,10 @@ server's name. gemini mcp remove ``` +**Options (Flags):** + +- `-s, --scope`: Configuration scope (user or project). [default: "project"] + **Example:** ```bash