summaryrefslogtreecommitdiff
path: root/docs/cli
diff options
context:
space:
mode:
authorScott Densmore <[email protected]>2025-06-14 15:19:05 -0700
committerGitHub <[email protected]>2025-06-14 15:19:05 -0700
commite30e650a77d7b6faaca9d799c508497e59992718 (patch)
tree0dc98be65ea27feb3de08cc2a75dfd00f5a05188 /docs/cli
parente544b940f12ec65379e3a8334ae9244e85ee3d74 (diff)
docs: document environment variables for cloud services (#1048)
Diffstat (limited to 'docs/cli')
-rw-r--r--docs/cli/configuration.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md
index f7925725..587ad071 100644
--- a/docs/cli/configuration.md
+++ b/docs/cli/configuration.md
@@ -209,6 +209,26 @@ The CLI automatically loads environment variables from an `.env` file. The loadi
- Specifies the default Gemini model to use.
- Overrides the hardcoded default, which is currently `gemini-2.5-pro-preview-05-06`.
- Example: `export GEMINI_MODEL="gemini-1.5-flash-latest"`
+- **`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.
+ - Example: `export GOOGLE_API_KEY="YOUR_GOOGLE_API_ KEY"`.
+- **`GOOGLE_CLOUD_PROJECT`**:
+ - Your Google Cloud Project ID.
+ - Required for using Code Assist, Telemetry or Vertex AI.
+ - If using Vertex AI, ensure you have the necessary permissions and set the `GOOGLE_GENAI_USE_VERTEXAI=true` environment variable.
+ - Example: `export 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.
+ - Example: `export GOOGLE_CLOUD_LOCATION="YOUR_PROJECT_LOCATION"`.
+- **`GEMINI_CODE_ASSIST`**:
+ - Enables Code Assist functionality.
+ - Accepts `true`, `false`, or a custom command string.
+ - If you are using an Enterprise account you should also set the `GOOGLE_CLOUD_PROJECT` environment variable.
+ - Example: `export GEMINI_CODE_ASSIST=true`.
- **`GEMINI_SANDBOX`**:
- Alternative to the `sandbox` setting in `settings.json`.
- Accepts `true`, `false`, `docker`, `podman`, or a custom command string.