From fa3981990c981152d54dd4f30f79dd27507e24b9 Mon Sep 17 00:00:00 2001 From: g-samroberts <158088236+g-samroberts@users.noreply.github.com> Date: Thu, 15 Jan 2026 07:59:31 -0800 Subject: [PATCH] Add links to supported locations and minor fixes (#16476) --- docs/changelogs/releases.md | 4 ++-- docs/cli/custom-commands.md | 18 +++++++++--------- docs/cli/index.md | 4 ++-- docs/cli/model-routing.md | 2 +- docs/cli/sandbox.md | 2 +- docs/local-development.md | 2 +- docs/troubleshooting.md | 13 ++++++++++++- 7 files changed, 28 insertions(+), 17 deletions(-) diff --git a/docs/changelogs/releases.md b/docs/changelogs/releases.md index 90b94140c3..23524cfc3c 100644 --- a/docs/changelogs/releases.md +++ b/docs/changelogs/releases.md @@ -1230,7 +1230,7 @@ https://github.com/google-gemini/gemini-cli/compare/v0.19.4...v0.20.0 https://github.com/google-gemini/gemini-cli/pull/12863 - feat(hooks): Hook Telemetry Infrastructure by @Edilmo in https://github.com/google-gemini/gemini-cli/pull/9082 -- fix: (some minor improvements to configs and getPackageJson return behaviour) +- fix: (some minor improvements to configs and getPackageJson return behavior) by @grMLEqomlkkU5Eeinz4brIrOVCUCkJuN in https://github.com/google-gemini/gemini-cli/pull/12510 - feat(hooks): Hook Event Handling by @Edilmo in @@ -1364,7 +1364,7 @@ https://github.com/google-gemini/gemini-cli/compare/v0.18.4...v0.19.0 https://github.com/google-gemini/gemini-cli/pull/12863 - feat(hooks): Hook Telemetry Infrastructure by @Edilmo in https://github.com/google-gemini/gemini-cli/pull/9082 -- fix: (some minor improvements to configs and getPackageJson return behaviour) +- fix: (some minor improvements to configs and getPackageJson return behavior) by @grMLEqomlkkU5Eeinz4brIrOVCUCkJuN in https://github.com/google-gemini/gemini-cli/pull/12510 - feat(hooks): Hook Event Handling by @Edilmo in diff --git a/docs/cli/custom-commands.md b/docs/cli/custom-commands.md index 2d251fc373..b70be823f1 100644 --- a/docs/cli/custom-commands.md +++ b/docs/cli/custom-commands.md @@ -50,7 +50,7 @@ Your command definition files must be written in the TOML format and use the ## Handling arguments Custom commands support two powerful methods for handling arguments. The CLI -automatically chooses the correct method based on the content of your command\'s +automatically chooses the correct method based on the content of your command's `prompt`. ### 1. Context-aware injection with `{{args}}` @@ -96,13 +96,13 @@ Search Results: """ ``` -When you run `/grep-code It\'s complicated`: +When you run `/grep-code It's complicated`: 1. The CLI sees `{{args}}` used both outside and inside `!{...}`. -2. Outside: The first `{{args}}` is replaced raw with `It\'s complicated`. +2. Outside: The first `{{args}}` is replaced raw with `It's complicated`. 3. Inside: The second `{{args}}` is replaced with the escaped version (e.g., on Linux: `"It\'s complicated"`). -4. The command executed is `grep -r "It\'s complicated" .`. +4. The command executed is `grep -r "It's complicated" .`. 5. The CLI prompts you to confirm this exact, secure command before execution. 6. The final prompt is sent. @@ -129,13 +129,13 @@ format and behavior. # In: /.gemini/commands/changelog.toml # Invoked via: /changelog 1.2.0 added "Support for default argument parsing." -description = "Adds a new entry to the project\'s CHANGELOG.md file." +description = "Adds a new entry to the project's CHANGELOG.md file." prompt = """ # Task: Update Changelog You are an expert maintainer of this software project. A user has invoked a command to add a new entry to the changelog. -**The user\'s raw command is appended below your instructions.** +**The user's raw command is appended below your instructions.** Your task is to parse the ``, ``, and `` from their input and use the `write_file` tool to correctly update the `CHANGELOG.md` file. @@ -147,7 +147,7 @@ The command follows this format: `/changelog ` 1. Read the `CHANGELOG.md` file. 2. Find the section for the specified ``. 3. Add the `` under the correct `` heading. -4. If the version or type section doesn\'t exist, create it. +4. If the version or type section doesn't exist, create it. 5. Adhere strictly to the "Keep a Changelog" format. """ ``` @@ -241,7 +241,7 @@ operate on specific files. **Example (`review.toml`):** This command injects the content of a _fixed_ best practices file -(`docs/best-practices.md`) and uses the user\'s arguments to provide context for +(`docs/best-practices.md`) and uses the user's arguments to provide context for the review. ```toml @@ -293,7 +293,7 @@ practice. description = "Asks the model to refactor the current context into a pure function." prompt = """ -Please analyze the code I\'ve provided in the current context. +Please analyze the code I've provided in the current context. Refactor it into a pure function. Your response should include: diff --git a/docs/cli/index.md b/docs/cli/index.md index 069c802411..94d04f5c63 100644 --- a/docs/cli/index.md +++ b/docs/cli/index.md @@ -25,8 +25,8 @@ overview of Gemini CLI, see the [main documentation page](../index.md). - **[Checkpointing](./checkpointing.md):** Automatically save and restore snapshots of your session and files. -- **[Enterprise configuration](./enterprise.md):** Deploying and manage Gemini - CLI in an enterprise environment. +- **[Enterprise configuration](./enterprise.md):** Deploy and manage Gemini CLI + in an enterprise environment. - **[Sandboxing](./sandbox.md):** Isolate tool execution in a secure, containerized environment. - **[Telemetry](./telemetry.md):** Configure observability to monitor usage and diff --git a/docs/cli/model-routing.md b/docs/cli/model-routing.md index 15105a4ef8..1f833d3f6e 100644 --- a/docs/cli/model-routing.md +++ b/docs/cli/model-routing.md @@ -11,7 +11,7 @@ health and automatically routes requests to available models based on defined policies. 1. **Model failure:** If the currently selected model fails (e.g., due to quota - or server errors), the CLI will iniate the fallback process. + or server errors), the CLI will initiate the fallback process. 2. **User consent:** Depending on the failure and the model's policy, the CLI may prompt you to switch to a fallback model (by default always prompts diff --git a/docs/cli/sandbox.md b/docs/cli/sandbox.md index 09bb8f76d3..28b54851c2 100644 --- a/docs/cli/sandbox.md +++ b/docs/cli/sandbox.md @@ -11,7 +11,7 @@ Before using sandboxing, you need to install and set up the Gemini CLI: npm install -g @google/gemini-cli ``` -To verify the installation +To verify the installation: ```bash gemini --version diff --git a/docs/local-development.md b/docs/local-development.md index 11cbbae139..e194307eae 100644 --- a/docs/local-development.md +++ b/docs/local-development.md @@ -10,7 +10,7 @@ debug your code by instrumenting interesting events like model calls, tool scheduler, tool calls, etc. Dev traces are verbose and are specifically meant for understanding agent -behaviour and debugging issues. They are disabled by default. +behavior and debugging issues. They are disabled by default. To enable dev traces, set the `GEMINI_DEV_TRACING=true` environment variable when running Gemini CLI. diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 2dea1c7212..515099934a 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -28,6 +28,16 @@ topics on: - **Organizational Users:** Contact your Google Cloud administrator to be added to your organization's Gemini Code Assist subscription. +- **Error: + `Failed to login. Message: Your current account is not eligible... because it is not currently available in your location.`** + - **Cause:** Gemini CLI does not currently support your location. For a full + list of supported locations, see the following pages: + - Gemini Code Assist for individuals: + [Available locations](https://developers.google.com/gemini-code-assist/resources/available-locations#americas) + - Google AI Pro and Ultra where Gemini Code Assist (and Gemini CLI) is also + available: + [Available locations](https://developers.google.com/gemini-code-assist/resources/locations-pro-ultra) + - **Error: `Failed to login. Message: Request contains an invalid argument`** - **Cause:** Users with Google Workspace accounts or Google Cloud accounts associated with their Gmail accounts may not be able to activate the free @@ -137,7 +147,8 @@ This is especially useful for scripting and automation. - **Core debugging:** - Check the server console output for error messages or stack traces. - - Increase log verbosity if configurable. + - Increase log verbosity if configurable. For example, set the `DEBUG_MODE` + environment variable to `true` or `1`. - Use Node.js debugging tools (e.g., `node --inspect`) if you need to step through server-side code.