diff options
| author | Arya Gummadi <[email protected]> | 2025-08-18 15:04:01 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-08-18 22:04:01 +0000 |
| commit | 4394b6ab4fc86637b07fcd26b9a790c627d1e065 (patch) | |
| tree | 12703fb3a73b6f035a3ecb7a96cc22f26d828064 /docs/cli | |
| parent | 5fe4e02310bdeae9ede4e6fe58dc77549b94d7cb (diff) | |
fix(docs): update authentication documentation to reflect available options (#6361)
Co-authored-by: Jacob Richman <[email protected]>
Diffstat (limited to 'docs/cli')
| -rw-r--r-- | docs/cli/configuration.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/cli/configuration.md b/docs/cli/configuration.md index 963c7f32..cb5ddcc1 100644 --- a/docs/cli/configuration.md +++ b/docs/cli/configuration.md @@ -336,7 +336,7 @@ The CLI keeps a history of shell commands you run. To avoid conflicts between di ## Environment Variables & `.env` Files -Environment variables are a common way to configure applications, especially for sensitive information like API keys or for settings that might change between environments. +Environment variables are a common way to configure applications, especially for sensitive information like API keys or for settings that might change between environments. For authentication setup, see the [Authentication documentation](./authentication.md) which covers all available authentication methods. The CLI automatically loads environment variables from an `.env` file. The loading order is: @@ -346,9 +346,9 @@ The CLI automatically loads environment variables from an `.env` file. The loadi **Environment Variable Exclusion:** Some environment variables (like `DEBUG` and `DEBUG_MODE`) are automatically excluded from being loaded from project `.env` files to prevent interference with gemini-cli behavior. Variables from `.gemini/.env` files are never excluded. You can customize this behavior using the `excludedProjectEnvVars` setting in your `settings.json` file. -- **`GEMINI_API_KEY`** (Required): +- **`GEMINI_API_KEY`**: - Your API key for the Gemini API. - - **Crucial for operation.** The CLI will not function without it. + - One of several available [authentication methods](./authentication.md). - Set this in your shell profile (e.g., `~/.bashrc`, `~/.zshrc`) or an `.env` file. - **`GEMINI_MODEL`**: - Specifies the default Gemini model to use. |
