Skip to content

Commit ca90b6d

Browse files
authored
docs: add configuration instructions (#87)
1 parent 34c7e82 commit ca90b6d

1 file changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,33 @@ gemini extensions install https://github.com/gemini-cli-extensions/bigquery-data
4343

4444
### Configuration
4545

46-
Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
46+
You will be prompted to configure the following settings during installation. These settings are saved in an `.env` file within the extension's directory.
47+
48+
* `BIGQUERY_PROJECT`: The GCP project ID.
49+
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
50+
51+
To view or update your configuration:
52+
53+
**List Settings:**
54+
* Terminal: `gemini extensions list`
55+
* Gemini CLI: `/extensions list`
56+
57+
**Update Settings:**
58+
* Terminal: `gemini extensions config bigquery-data-analytics [setting name] [--scope <scope>]`
59+
* `setting name`: (Optional) The single setting to configure.
60+
* `scope`: (Optional) The scope of the setting in (`user` or `workspace`). Defaults to `user`.
61+
* Currently, you must restart the Gemini CLI for changes to take effect. We recommend using `gemini --resume` to resume your session.
62+
63+
Alternatively, you can manually set these environment variables before starting the Gemini CLI:
4764

4865
```bash
4966
export BIGQUERY_PROJECT="<your-gcp-project-id>"
5067
export BIGQUERY_LOCATION="<your-dataset-location>" # Optional
5168
```
5269

53-
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
70+
> [!NOTE]
71+
> * Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
72+
> * See [Troubleshooting](#troubleshooting) for debugging your configuration.
5473
5574
### Start Gemini CLI
5675

0 commit comments

Comments
 (0)