diff options
| author | Marat Boshernitsan <[email protected]> | 2025-07-08 09:37:10 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-07-08 16:37:10 +0000 |
| commit | f1647d9e19bf6930bc50bd2e66d2929f8f771503 (patch) | |
| tree | 9419cbc6345c775f4c3bf21a9437a1614cf8fc33 /docs/cli/configuration.md | |
| parent | 5c759d48c7e49b84f35544478d86cfe60a41b569 (diff) | |
Improve auth env var validation logic and messaging to detect settings that confuse GenAI SDK (#1381)
Co-authored-by: Scott Densmore <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/cli/configuration.md')
| -rw-r--r-- | docs/cli/configuration.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 31931391..5f0514b0 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -242,12 +242,12 @@ The CLI automatically loads environment variables from an `.env` file. The loadi - **`GOOGLE_API_KEY`**: - Your Google Cloud API key. - Required for using Vertex AI in express mode. - - Ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable. + - Ensure you have the necessary permissions. - Example: `export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"`. - **`GOOGLE_CLOUD_PROJECT`**: - Your Google Cloud Project ID. - Required for using Code Assist or Vertex AI. - - If using Vertex AI, ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable. + - If using Vertex AI, ensure you have the necessary permissions in this project. - **Cloud Shell Note:** When running in a Cloud Shell environment, this variable defaults to a special project allocated for Cloud Shell users. If you have `GOOGLE_CLOUD_PROJECT` set in your global environment in Cloud Shell, it will be overridden by this default. To use a different project in Cloud Shell, you must define `GOOGLE_CLOUD_PROJECT` in a `.env` file. - Example: `export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"`. - **`GOOGLE_APPLICATION_CREDENTIALS`** (string): @@ -258,8 +258,7 @@ The CLI automatically loads environment variables from an `.env` file. The loadi - Example: `export OTLP_GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_ID"`. - **`GOOGLE_CLOUD_LOCATION`**: - Your Google Cloud Project Location (e.g., us-central1). - - Required for using Vertex AI in non-express mode. - - If using Vertex AI, ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable. + - Required for using Vertex AI in non express mode. - Example: `export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION"`. - **`GEMINI_SANDBOX`**: - Alternative to the `sandbox` setting in `settings.json`. |